Class ProjectArchiveExporter

    • Constructor Detail

      • ProjectArchiveExporter

        public ProjectArchiveExporter()
    • Method Detail

      • export

        public boolean export​( 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
        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
        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
        domainObjectService - a service for retrieving the applicable domainObject.
        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
        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.
        canExportDomainObject in class Exporter
        true if this exporter knows how to export the given domain object.