Class TimeFilter

java.lang.Object
org.apache.log4j.spi.Filter
org.apache.log4j.filter.TimeFilter
All Implemented Interfaces:
org.apache.log4j.spi.OptionHandler
public final class TimeFilter extends org.apache.log4j.spi.Filter
Filters events that fall within a specified time period in each day.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private boolean
    acceptOnMatch
     
    private Calendar
    calendar
    Timezone.
    private long
    end
    Ending offset from midnight in milliseconds.
    private static final long
    HOUR_MS
    Length of hour in milliseconds.
    private static final long
    MINUTE_MS
    Length of minute in milliseconds.
    private static final long
    SECOND_MS
    Length of second in milliseconds.
    private long
    start
    Starting offset from midnight in milliseconds.

    Fields inherited from class org.apache.log4j.spi.Filter

    ACCEPT, DENY, NEUTRAL, next

  • Constructor Summary

    Constructors
    Constructor
    Description
    TimeFilter()
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    decide(org.apache.log4j.spi.LoggingEvent event)
    boolean
    getAcceptOnMatch()
    Gets whether an event within the timespan should be accepted or denied.
    void
    setAcceptOnMatch(boolean acceptOnMatch)
    Sets whether an event within the timespan should be accepted or denied.
    void
    setEnd(String s)
    Set end (exclusive) of time span.
    void
    setStart(String s)
    Set start (inclusive) of time span.
    void
    setTimeZone(String s)
    Set timezone.

    Methods inherited from class org.apache.log4j.spi.Filter

    activateOptions, getNext, setNext

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • acceptOnMatch

      private boolean acceptOnMatch

    • start

      private long start
      Starting offset from midnight in milliseconds.

    • end

      private long end
      Ending offset from midnight in milliseconds.

    • calendar

      private Calendar calendar
      Timezone.

    • HOUR_MS

      private static final long HOUR_MS
      Length of hour in milliseconds.
      See Also:

    • MINUTE_MS

      private static final long MINUTE_MS
      Length of minute in milliseconds.
      See Also:

    • SECOND_MS

      private static final long SECOND_MS
      Length of second in milliseconds.
      See Also:

  • Constructor Details

    • TimeFilter

      public TimeFilter()
      Constructor.

  • Method Details

    • setStart

      public void setStart(String s)
      Set start (inclusive) of time span.
      Parameters:
      s - string representation of start time as HH:mm:ss.

    • setEnd

      public void setEnd(String s)
      Set end (exclusive) of time span.
      Parameters:
      s - string representation of end time as HH:mm:ss.

    • setTimeZone

      public void setTimeZone(String s)
      Set timezone.
      Parameters:
      s - time zone.

    • setAcceptOnMatch

      public void setAcceptOnMatch(boolean acceptOnMatch)
      Sets whether an event within the timespan should be accepted or denied.
      Parameters:
      acceptOnMatch - true if matching event should be accepted.

    • getAcceptOnMatch

      public boolean getAcceptOnMatch()
      Gets whether an event within the timespan should be accepted or denied.
      Returns:
      true if matching event should be accepted.

    • decide

      public int decide(org.apache.log4j.spi.LoggingEvent event)
      Specified by:
      decide in class org.apache.log4j.spi.Filter