Package ghidra.app.util.exporter
Class ProjectArchiveExporter
java.lang.Object
ghidra.app.util.exporter.Exporter
ghidra.app.util.exporter.ProjectArchiveExporter
- All Implemented Interfaces:
ExtensionPoint
-
Field Summary
FieldsFields inherited from class ghidra.app.util.exporter.Exporter
EMPTY_OPTIONS, log, provider
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
canExportDomainObject
(Class<? extends DomainObject> domainObjectClass) Returns true if this exporter knows how to export the given domain object.boolean
export
(File file, DomainObject domainObj, AddressSetView addrSet, TaskMonitor monitor) Actually does the work of exporting the program.getOptions
(DomainObjectService domainObjectService) Returns the available options for this exporter.void
setOptions
(List<Option> options) Sets the options.Methods inherited from class ghidra.app.util.exporter.Exporter
getDefaultFileExtension, getHelpLocation, getMessageLog, getName, setExporterServiceProvider, supportsPartialExport, toString
-
Field Details
-
NAME
- See Also:
-
-
Constructor Details
-
ProjectArchiveExporter
public ProjectArchiveExporter()
-
-
Method Details
-
export
public boolean export(File file, DomainObject domainObj, AddressSetView addrSet, TaskMonitor monitor) Description copied from class:Exporter
Actually does the work of exporting the program.- Specified by:
export
in classExporter
- Parameters:
file
- the output file to write the exported infodomainObj
- the domain object to exportaddrSet
- the address set if only a portion of the program should be exportedmonitor
- the task monitor- Returns:
- true if the program was successfully exported; otherwise, false. If the program was not successfully exported, the message log should be checked to find the source of the error.
-
getOptions
Description copied from class:Exporter
Returns the available options for this exporter. The program is needed because some exporters may have options that vary depending on the specific program being exported.- Specified by:
getOptions
in classExporter
- Parameters:
domainObjectService
- a service for retrieving the applicable domainObject.- Returns:
- the available options for this exporter
-
setOptions
Description copied from class:Exporter
Sets the options. This method is not for defining the options, but rather it is for setting the values of options. If invalid options are passed in, then OptionException should be thrown.- Specified by:
setOptions
in classExporter
- Parameters:
options
- the option values for this exporter
-
canExportDomainObject
Description copied from class:Exporter
Returns true if this exporter knows how to export the given domain object. For example, some exporters know how to export programs, other exporters can export project data type archives.- Overrides:
canExportDomainObject
in classExporter
- Parameters:
domainObjectClass
- the class of the domain object to test for exporting.- Returns:
- true if this exporter knows how to export the given domain object.
-