Package adams.flow.transformer

Class Touch

  • 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 Touch
extends AbstractTransformer
    Like the Unix 'touch' command, updates the 'last modified' timestamp of the file coming through.
    By default, it creates the file if it doesn't exist.

    Input/output:
    - accepts:
       java.lang.String
       java.io.File
    - generates:
       java.lang.String
       java.io.File


    -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: Touch
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default:
 
    -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
    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
 
    -create-file <boolean> (property: createFile)
    If enabled, the file gets created if it doesn't exist.
    default: true
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_CreateFile

        protected boolean m_CreateFile
        whether to create the file if not existing.

    • Constructor Detail

      • Touch

        public Touch()

    • Method Detail

      • setCreateFile

        public void setCreateFile​(boolean value)
        Sets whether to create the file if it doesn't exist.
        Parameters:
        value - true if to create

      • getCreateFile

        public boolean getCreateFile()
        Returns whether to create the file it doesn't exist.
        Returns:
        true if to create

      • createFileTipText

        public String createFileTipText()
        Returns the tip text for this property.
        Returns:
        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.
        Returns:
        the Class of objects that can be processed

      • generates

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

      • doExecute

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