Package ghidra.app.util.exporter

Class ProgramExporter

java.lang.Object

ghidra.app.util.exporter.Exporter

ghidra.app.util.exporter.ProgramExporter

All Implemented Interfaces:

ExtensionPoint

Direct Known Subclasses:

AsciiExporter, BinaryExporter, CppExporter, HtmlExporter, IntelHexExporter, OriginalFileExporter, XmlExporter

public abstract class ProgramExporter NEW
extends Exporter

ProgramExporter provides an abstract Exporter implementation for Program objects.

Field Summary

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

EMPTY_OPTIONS, log, provider

Constructor Summary

Constructors

Change	Modifier	Constructor	Description
	protected	ProgramExporter(String name, String extension, HelpLocation help)	Constructs a new Program exporter.

Method Summary

Change	Modifier and Type	Method	Description
	boolean	canExportDomainObject(Class<? extends DomainObject> domainObjectClass)	Returns true if this exporter is capable of exporting the given domain file/object content type.
	protected Program	getProgram(DomainObject domainObj)	Get an exportable Program instance from the specified DomainObject instance.

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

canExportDomainFile, canExportDomainObject, export, export, getDefaultFileExtension, getHelpLocation, getMessageLog, getName, getOptions, setExporterServiceProvider, setOptions, supportsAddressRestrictedExport, toString

Methods inherited from class java.lang.Object

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

Constructor Details

ProgramExporter

protected ProgramExporter(String name,
 String extension,
 HelpLocation help)

Constructs a new Program exporter.

Parameters:

name - the display name of this exporter

extension - the default extension for this exporter

help - the help location for this exporter

Method Details

getProgram

protected Program getProgram(DomainObject domainObj)
                      throws ClassCastException

Get an exportable Program instance from the specified DomainObject instance. The specified instance must satisfy canExportDomainObject(Class).

Parameters:

domainObj - domain object from which a Program may be derived.

Returns:

Program instance

Throws:

ClassCastException - if domain object class does not satisfy canExportDomainObject(Class).

canExportDomainObject

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

Description copied from class: Exporter

Returns true if this exporter is capable of exporting the given domain file/object content type. For example, some exporters have the ability to export programs, other exporters can export other DomainFile or DomainObject types such as project data type archives.

NOTE: This method should only be used as a preliminary check, if necessary, to identify exporter implementations that are capable of handling a specified content type/class. Prior to export a final check should be performed based on the export or either a DomainFile or DomainObject:

DomainFile export - the method Exporter.canExportDomainFile(DomainFile) should be used to verify a direct project file export is possible using the Exporter.export(File, DomainFile, TaskMonitor) method which may avoid opening the file first.

DomainObject export - the method Exporter.canExportDomainObject(DomainObject) should be used to verify an export of a specific object is possible before using the Exporter.export(File, DomainObject, AddressSetView, TaskMonitor) method.

Specified by:

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 type.