Class HeapDump

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, FileWriter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ControlActor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable

    public class HeapDump
    extends AbstractTransformer
    implements ControlActor, FileWriter
    Generates a heapdump and saves it to the specified file (with .hprof extension) whenever a token passes through.

    - accepts:
    - generates:

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
        The logging level for outputting errors and debugging output.
        default: WARNING
    -name <java.lang.String> (property: name)
        The name of the actor.
        default: HeapDump
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
        The annotations to attach to this actor.
    -skip <boolean> (property: skip)
        If set to true, transformation is skipped and the input token is just forwarded
        as it is.
        default: false
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
        If set to true, the flow execution at this level gets stopped in case this
        actor encounters an error; the error gets propagated; useful for critical
        default: false
    -silent <boolean> (property: silent)
        If enabled, then no errors are output in the console; Note: the enclosing
        actor handler must have this enabled as well.
        default: false
    -output-file <> (property: outputFile)
        The file to save the heapdump to (must have .hprof extension).
        default: ${CWD}
    -live <boolean> (property: live)
        If enabled, only live objects are output.
        default: true
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Field Detail

      • m_Live

        protected boolean m_Live
        whether to output only live objects.
    • Constructor Detail

      • HeapDump

        public HeapDump()
    • Method Detail

      • outputFileTipText

        public String outputFileTipText()
        Returns the tip text for this property.
        Specified by:
        outputFileTipText in interface FileWriter
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setLive

        public void setLive​(boolean value)
        Sets whether to output only live objects.
        value - true if only live
      • getLive

        public boolean getLive()
        Returns whether to output only live objects.
        true if only live
      • liveTipText

        public String liveTipText()
        Returns the tip text for this property.
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Specified by:
        accepts in interface InputConsumer
      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Specified by:
        generates in interface OutputProducer
      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        null if everything is fine, otherwise error message