Package ghidra.app.util.exporter

Class ProjectArchiveExporter

java.lang.Object

ghidra.app.util.exporter.Exporter

ghidra.app.util.exporter.ProjectArchiveExporter

All Implemented Interfaces:

ExtensionPoint

public class ProjectArchiveExporter
extends Exporter

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	NAME

Fields inherited from class ghidra.app.util.exporter.Exporter

EMPTY_OPTIONS, log, provider

Constructor Summary

Constructors

Constructor	Description
ProjectArchiveExporter()

Method Summary

Modifier and Type	Method	Description
boolean	canExportDomainObject(java.lang.Class<? extends DomainObject> domainObjectClass)	Returns true if this exporter knows how to export the given domain object.
boolean	export(java.io.File file, DomainObject domainObj, AddressSetView addrSet, TaskMonitor monitor)	Actually does the work of exporting the program.
java.util.List<Option>	getOptions(DomainObjectService domainObjectService)	Returns the available options for this exporter.
void	setOptions(java.util.List<Option> options)	Sets the options.

Methods inherited from class ghidra.app.util.exporter.Exporter

getDefaultFileExtension, getHelpLocation, getMessageLog, getName, setExporterServiceProvider, supportsPartialExport, toString

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

ProjectArchiveExporter

public ProjectArchiveExporter()

Method Detail

export

public boolean export(java.io.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 class Exporter

Parameters:

file - the output file to write the exported info

domainObj - the domain object to export

addrSet - the address set if only a portion of the program should be exported

monitor - 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

public java.util.List<Option> getOptions(DomainObjectService domainObjectService)

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 class Exporter

Parameters:

domainObjectService - a service for retrieving the applicable domainObject.

Returns:

the available options for this exporter

setOptions

public void setOptions(java.util.List<Option> options)

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 class Exporter

Parameters:

options - the option values for this exporter

canExportDomainObject

public boolean canExportDomainObject(java.lang.Class<? extends DomainObject> domainObjectClass)

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 class Exporter

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.