Package ghidra.app.util.exporter

Class AbstractLoaderExporter

java.lang.Object

ghidra.app.util.exporter.Exporter

ghidra.app.util.exporter.AbstractLoaderExporter

All Implemented Interfaces:

ExtensionPoint

Direct Known Subclasses:

ElfExporter, PeExporter

public abstract class AbstractLoaderExporter
extends Exporter

An Exporter that can export programs imported with a particular Loader

Field Summary

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

EMPTY_OPTIONS, log, provider

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractLoaderExporter(java.lang.String name, HelpLocation help)	Creates a new AbstractLoaderExporter

Method Summary

Modifier and Type	Method	Description
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.
protected abstract boolean	supportsFileFormat(java.lang.String fileFormat)	Checks to see if the given file format is supported by this exporter

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractLoaderExporter

protected AbstractLoaderExporter(java.lang.String name,
                                 HelpLocation help)

Creates a new AbstractLoaderExporter

Parameters:

name - The display name of this exporter

help - The HelpLocation for this exporter

Method Detail

supportsFileFormat

protected abstract boolean supportsFileFormat(java.lang.String fileFormat)

Checks to see if the given file format is supported by this exporter

Parameters:

fileFormat - The file format (loader name) of the program to export

Returns:

True if the given file format is supported by this exporter; otherwise, false

export

public boolean export(java.io.File file,
                      DomainObject domainObj,
                      AddressSetView addrSet,
                      TaskMonitor monitor)
               throws java.io.IOException,
                      ExporterException

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.

Throws:

java.io.IOException

ExporterException

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