Package ghidra.app.util.opinion

Class LoadResults<T extends DomainObject>

java.lang.Object

ghidra.app.util.opinion.LoadResults<T>

Type Parameters:

T - The type of DomainObjects that were loaded

All Implemented Interfaces:

Iterable<Loaded<T>>

public class LoadResults<T extends DomainObject>
extends Object
implements Iterable<Loaded<T>>

The result of a load. A LoadResults object provides convenient access to and operations on the underlying Loaded DomainObjects that got loaded.

Constructor Summary

Constructors

Constructor	Description
LoadResults(List<Loaded<T>> loadedList)	Creates a new LoadResults that contains the given non-empty List of Loaded DomainObjects.
LoadResults(T domainObject, String name, String projectFolderPath)	Creates a new LoadResults that contains a new Loaded DomainObject created from the given parameters.

Method Summary

Modifier and Type	Method	Description
Loaded<T>	getPrimary()	Gets the "primary" Loaded DomainObject, who's meaning is defined by each Loader implementation
T	getPrimaryDomainObject()	Gets the "primary" DomainObject, who's meaning is defined by each Loader implementation
Iterator<Loaded<T>>	iterator()
void	release(Object consumer)	Notify all of the Loaded DomainObjects that the specified consumer is no longer using them.
void	release(Object consumer, Predicate<? super Loaded<T>> filter)	Notify the filtered Loaded DomainObjects that the specified consumer is no longer using them.
void	releaseNonPrimary(Object consumer)	Notify the non-primary Loaded DomainObjects that the specified consumer is no longer using them.
void	save(Project project, Object consumer, MessageLog messageLog, TaskMonitor monitor)	Saves each Loaded DomainObject to the given Project.
int	size()	Gets the number of Loaded DomainObjects in this LoadResults.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

LoadResults

public LoadResults(List<Loaded<T>> loadedList)
            throws IllegalArgumentException

Creates a new LoadResults that contains the given non-empty List of Loaded DomainObjects. The first entry in the List is assumed to be the primary Loaded DomainObject.

Parameters:

loadedList - A List of Loaded DomainObjects

Throws:

IllegalArgumentException - if the provided List is null or empty

LoadResults

public LoadResults(T domainObject,
 String name,
 String projectFolderPath)

Creates a new LoadResults that contains a new Loaded DomainObject created from the given parameters. This new Loaded DomainObject is assumed to be the primary Loaded DomainObject.

Parameters:

domainObject - The loaded DomainObject

name - The name of the loaded DomainObject. If a save occurs, this will attempted to be used for the resulting DomainFile's name.

projectFolderPath - The project folder path this will get saved to during a save operation. If null or empty, the root project folder will be used.

Method Details

getPrimary

public Loaded<T> getPrimary()

Gets the "primary" Loaded DomainObject, who's meaning is defined by each Loader implementation

Returns:

The "primary" Loaded DomainObject

getPrimaryDomainObject

public T getPrimaryDomainObject()

Gets the "primary" DomainObject, who's meaning is defined by each Loader implementation

Returns:

The "primary" DomainObject

size

public int size()

Gets the number of Loaded DomainObjects in this LoadResults. The size will always be greater than 0.

Returns:

The number of Loaded DomainObjects in this LoadResults

save

public void save(Project project,
 Object consumer,
 MessageLog messageLog,
 TaskMonitor monitor)
          throws CancelledException,
IOException

Saves each Loaded DomainObject to the given Project.

NOTE: If any fail to save, none will be saved (already saved DomainFiles will be cleaned up/deleted), and all Loaded DomainObjects will have been released.

Parameters:

project - The Project to save to

consumer - the consumer

messageLog - The log

monitor - A cancelable task monitor

Throws:

CancelledException - if the operation was cancelled

IOException - If there was a problem saving

See Also:

• Loaded.save(Project, MessageLog, TaskMonitor)

release

public void release(Object consumer)

Notify all of the Loaded DomainObjects that the specified consumer is no longer using them. When the last consumer invokes this method, the Loaded DomainObjects will be closed and will become invalid.

Parameters:

consumer - the consumer

release

public void release(Object consumer,
 Predicate<? super Loaded<T>> filter)

Notify the filtered Loaded DomainObjects that the specified consumer is no longer using them. When the last consumer invokes this method, the filtered Loaded DomainObjects will be closed and will become invalid.

Parameters:

consumer - the consumer

filter - a filter to apply to the Loaded DomainObjects prior to the release

releaseNonPrimary

public void releaseNonPrimary(Object consumer)

Notify the non-primary Loaded DomainObjects that the specified consumer is no longer using them. When the last consumer invokes this method, the non-primary Loaded DomainObjects will be closed and will become invalid.

Parameters:

consumer - the consumer

iterator

public Iterator<Loaded<T>> iterator()

Specified by:

iterator in interface Iterable<T extends DomainObject>