Class CreateConsoleAppenderTask

  • All Implemented Interfaces:
    SubTask

    public class CreateConsoleAppenderTask
    extends CreateAppenderTask

    A Rhino management sub task for creating a log appender with output directed to the console.

    Ant Parameters
    Attribute Type Description Required

    appendername

    String

    Name of the appender to create. This name must be unique.

    Yes.

    direct

    boolean

    Log directly to the output stream instead of via the System.out/err PrintWriter

    No.

    follow

    boolean

    Follow changes to the destination stream of System.out/err. Incompatible with direct.

    No.

    target

    String

    Either "SYSTEM_OUT" or "SYSTEM_ERR". The default is "SYSTEM_OUT".

    No.

    ignoreexceptions

    boolean

    Log exceptions thrown by this appender then ignore them. If set to false propagate to the caller (used to support selective appenders e.g. FailoverAppender).

    No.

    failonerror

    boolean

    Flag to control failure behaviour. If 'true', the sub task will throw a BuildException when an error is encountered. If 'false', the sub task will throw a NonFatalBuildException instead of a BuildException under specific circumstances. See below for conditions (if any) which will cause a NonFatalBuildException.

    No. Default value is taken from the Rhino management parent task.

    Nested elements

    Element

    Description

    Required

    filter

    A filter to select events that will be reported by this appender.

    No.

    layout

    The layout to use to format log events. If no layout is supplied the default pattern layout of "%m%n" will be used.

    No.

    NonFatalBuildException throw conditions
    • This task will throw a NonFatalBuildException if the appender cannot be created, eg. an appender with the same name already exists.

    • Constructor Detail

      • CreateConsoleAppenderTask

        public CreateConsoleAppenderTask()
    • Method Detail

      • validateParameters

        protected void validateParameters()
                                   throws org.apache.tools.ant.BuildException
        Overrides:
        validateParameters in class CreateAppenderTask
        Throws:
        org.apache.tools.ant.BuildException
      • setDirect

        public void setDirect​(boolean direct)
      • setFollow

        public void setFollow​(boolean follow)
      • setTarget

        public void setTarget​(String target)