Package adams.flow.sink

Class JavaLogging

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, Serializable, Comparable
    public class JavaLogging
extends AbstractSink
    Uses the Java logging framework to output the incoming data.
    Simply uses an object's 'toString()' method.

    Input/output:
    - accepts:
       java.lang.Object


    -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: JavaLogging
 
    -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
 
    -logger-name <java.lang.String> (property: loggerName)
    The logger name to use; if left empty, the full actor name is used.
    default: 
 
    -logger-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggerLevel)
    The level to use for the logger.
    default: INFO
    Version:
    $Revision$
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_LoggerName

        protected String m_LoggerName
        the logger name.

      • m_LoggerLevel

        protected LoggingLevel m_LoggerLevel
        the logger level.

      • m_ActualLogger

        protected transient Logger m_ActualLogger
        the logger in use.

    • Constructor Detail

      • JavaLogging

        public JavaLogging()

    • Method Detail

      • setLoggerName

        public void setLoggerName​(String value)
        Sets the logger name. Uses the full actor's name if left empty.
        Parameters:
        value - the name

      • getLoggerName

        public String getLoggerName()
        Returns the logger name. Uses the full actor's name if left empty.
        Returns:
        the name

      • loggerNameTipText

        public String loggerNameTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setLoggerLevel

        public void setLoggerLevel​(LoggingLevel value)
        Sets the logging level.
        Parameters:
        value - the level

      • getLoggerLevel

        public LoggingLevel getLoggerLevel()
        Returns the logging level.
        Returns:
        the level

      • loggerLevelTipText

        public String loggerLevelTipText()
        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

      • doExecute

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