Package ghidra.app.util.exporter
Class HtmlExporter
- java.lang.Object
-
- ghidra.app.util.exporter.Exporter
-
- ghidra.app.util.exporter.HtmlExporter
-
- All Implemented Interfaces:
ExtensionPoint
public class HtmlExporter extends Exporter
An implementation of exporter that creates an HTML representation of the program.
-
-
Field Summary
-
Fields inherited from class ghidra.app.util.exporter.Exporter
EMPTY_OPTIONS, log, provider
-
-
Constructor Summary
Constructors Constructor Description HtmlExporter()
Constructs a new HTML exporter.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
export(java.io.File file, DomainObject domainObj, AddressSetView addressSet, 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
canExportDomainObject, getDefaultFileExtension, getHelpLocation, getMessageLog, getName, setExporterServiceProvider, supportsPartialExport, toString
-
-
-
-
Method Detail
-
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 classExporter
- 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) throws OptionException
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- Throws:
OptionException
- if invalid options are passed in
-
export
public boolean export(java.io.File file, DomainObject domainObj, AddressSetView addressSet, TaskMonitor monitor) throws java.io.IOException, ExporterException
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 exportaddressSet
- 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.
- Throws:
java.io.IOException
ExporterException
-
-