Package adams.flow.transformer

Class Diff

  • 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 Diff
extends AbstractTransformer
    Compares two files or two string arrays and generates a diff representation.
    In case of BRIEF, the output is whether the two files/arrays are different.

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


    -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: Diff
 
    -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 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
 
    -type <BRIEF|UNIFIED|SIDE_BY_SIDE> (property: type)
    The type of diff string to generate.
    default: UNIFIED
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Type

        protected Diff.DiffType m_Type
        the type of diff to generate.

    • Constructor Detail

      • Diff

        public Diff()

    • Method Detail

      • setType

        public void setType​(Diff.DiffType value)
        Sets the type of diff string to generate.
        Parameters:
        value - the type

      • getType

        public Diff.DiffType getType()
        Returns the type of diff string to generate.
        Returns:
        the type

      • typeTipText

        public String typeTipText()
        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:
        java.lang.String[].class, java.io.File[].class, java.lang.String[][].class

      • generates

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

      • doExecute

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