Class HexReplace

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

    public class HexReplace
    extends AbstractTransformer
    Allows to find and replace characters in hex notation.

    - 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: HexReplace
    -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 gets stopped in case this actor encounters an error;
         useful for critical actors.
        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
    -find <java.lang.String> (property: find)
        The bytes in hexadecimal notation to find (eg 0D0A for CRLF).
    -replace <java.lang.String> (property: replace)
        The string in hexadecimal notation to replace the occurrences with (eg 0A
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Field Detail

      • m_Find

        protected String m_Find
        the search string in hex.
      • m_Replace

        protected String m_Replace
        the replacement string in hex.
    • Constructor Detail

      • HexReplace

        public HexReplace()
    • Method Detail

      • setFind

        public void setFind​(String value)
        Sets the hex string to find.
        value - the hex string
      • getFind

        public String getFind()
        Returns the hex string to find.
        the hex string
      • findTipText

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

        public void setReplace​(String value)
        Sets the string to replace the occurrences with.
        value - the string
      • getReplace

        public String getReplace()
        Returns the string to replace the occurences with.
        the string
      • replaceTipText

        public String replaceTipText()
        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.
        the Class of objects that can be processed
      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        the Class of the generated tokens
      • doExecute

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