Package ghidra.app.util.opinion

Class LoadedOpen<T extends DomainObject>

java.lang.Object

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

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

Type Parameters:

T - The type of open DomainObject

All Implemented Interfaces:

AutoCloseable

public class LoadedOpen<T extends DomainObject>
extends Loaded<T>

A loaded, open DomainObject that has already been saved to a DomainFile

Field Summary

Fields inherited from class ghidra.app.util.opinion.Loaded

domainFile, domainObject, fsrl, loadedConsumer, mirrorFsLayout, name, project, projectRootPath

Constructor Summary

Constructors

Constructor	Description
LoadedOpen(T domainObject, DomainFile domainFile, FSRL fsrl, Object consumer)	Creates a Loaded view on an existing DomainFile.

Method Summary

Modifier and Type	Method	Description
DomainFile	save(TaskMonitor monitor)	Saves the loaded DomainObject to the given Project at this object's project folder path, using this object's name.

Methods inherited from class ghidra.app.util.opinion.Loaded

apply, check, close, getDomainObject, getDomainObject, getDomainObjectType, getName, getProject, getProjectFolderPath, getSavedDomainFile, release, setProjectFolderPath, toString

Methods inherited from class java.lang.Object

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

Constructor Details

LoadedOpen

public LoadedOpen(T domainObject,
 DomainFile domainFile,
 FSRL fsrl,
 Object consumer)
           throws LoadException

Creates a Loaded view on an existing DomainFile. This type of Loaded object cannot be re-saved.

Parameters:

domainObject - The loaded DomainObject

domainFile - The DomainFile associated with the loaded DomainObject

fsrl - The FSRL of the loaded DomainObject

consumer - A reference to the object "consuming" the returned Loaded DomainObject, used to ensure the underlying DomainObject is only closed when every consumer is done with it (see Loaded.close()). NOTE: Wrapping a DomainObject in a Loaded transfers responsibility of releasing the given DomainObject to this Loaded's Loaded.close() method.

Throws:

LoadException - if the given DomainFile is not open

Method Details

save

public DomainFile save(TaskMonitor monitor)

Description copied from class: Loaded

Saves the loaded DomainObject to the given Project at this object's project folder path, using this object's name.

If a DomainFile already exists with the same desired name and project folder path, the desired name will get a counter value appended to it to avoid a naming conflict. Therefore, it should not be assumed that the returned DomainFile will have the same name as a call to Loaded.getName().

Overrides:

save in class Loaded<T extends DomainObject>

Parameters:

monitor - A cancelable task monitor

Returns:

The DomainFile where the save happened