Package org.apache.log4j.helpers

Class DateLayout

  • All Implemented Interfaces:
    OptionHandler
    Direct Known Subclasses:
    TTCCLayout
    public abstract class DateLayout
extends Layout
    This abstract layout takes care of all the date related options and formatting work.
    Author:
    Ceki Gülcü

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.util.Date date  
      static java.lang.String DATE_FORMAT_OPTION
      Deprecated.
      Options are now handled using the JavaBeans paradigm.
      protected java.text.DateFormat dateFormat  
      static java.lang.String NULL_DATE_FORMAT
      String constant designating no time information.
      protected java.text.FieldPosition pos  
      static java.lang.String RELATIVE_TIME_DATE_FORMAT
      String constant designating relative time.
      static java.lang.String TIMEZONE_OPTION
      Deprecated.
      Options are now handled using the JavaBeans paradigm.

    • Constructor Summary

      Constructors 
      Constructor Description
      DateLayout()  

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void activateOptions()
      Activate the options that were previously set with calls to option setters.
      void dateFormat​(java.lang.StringBuffer buf, LoggingEvent event)  
      java.lang.String getDateFormat()
      Returns value of the DateFormat option.
      java.lang.String[] getOptionStrings()
      Deprecated.
      Use the setter method for the option directly instead of the generic setOption method.
      java.lang.String getTimeZone()
      Returns value of the TimeZone option.
      void setDateFormat​(java.lang.String dateFormat)
      The value of the DateFormat option should be either an argument to the constructor of SimpleDateFormat or one of the srings "NULL", "RELATIVE", "ABSOLUTE", "DATE" or "ISO8601.
      void setDateFormat​(java.lang.String dateFormatType, java.util.TimeZone timeZone)
      Sets the DateFormat used to format date and time in the time zone determined by timeZone parameter.
      void setDateFormat​(java.text.DateFormat dateFormat, java.util.TimeZone timeZone)
      Sets the DateFormat used to format time and date in the zone determined by timeZone.
      void setOption​(java.lang.String option, java.lang.String value)
      Deprecated.
      Use the setter method for the option directly instead of the generic setOption method.
      void setTimeZone​(java.lang.String timeZone)
      The TimeZoneID option is a time zone ID string in the format expected by the TimeZone.getTimeZone(java.lang.String) method.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • NULL_DATE_FORMAT

        public static final java.lang.String NULL_DATE_FORMAT
        String constant designating no time information. Current value of this constant is NULL.
        See Also:
        Constant Field Values

      • RELATIVE_TIME_DATE_FORMAT

        public static final java.lang.String RELATIVE_TIME_DATE_FORMAT
        String constant designating relative time. Current value of this constant is RELATIVE.
        See Also:
        Constant Field Values

      • pos

        protected java.text.FieldPosition pos

      • DATE_FORMAT_OPTION

        public static final java.lang.String DATE_FORMAT_OPTION
        Deprecated.
        Options are now handled using the JavaBeans paradigm. This constant is not longer needed and will be removed in the near term.
        See Also:
        Constant Field Values

      • TIMEZONE_OPTION

        public static final java.lang.String TIMEZONE_OPTION
        Deprecated.
        Options are now handled using the JavaBeans paradigm. This constant is not longer needed and will be removed in the near term.
        See Also:
        Constant Field Values

      • dateFormat

        protected java.text.DateFormat dateFormat

      • date

        protected java.util.Date date

    • Constructor Detail

      • DateLayout

        public DateLayout()

    • Method Detail

      • getOptionStrings

        public java.lang.String[] getOptionStrings()
        Deprecated.
        Use the setter method for the option directly instead of the generic setOption method.

      • setOption

        public void setOption​(java.lang.String option,
                      java.lang.String value)
        Deprecated.
        Use the setter method for the option directly instead of the generic setOption method.

      • setDateFormat

        public void setDateFormat​(java.lang.String dateFormat)
        The value of the DateFormat option should be either an argument to the constructor of SimpleDateFormat or one of the srings "NULL", "RELATIVE", "ABSOLUTE", "DATE" or "ISO8601.

      • getDateFormat

        public java.lang.String getDateFormat()
        Returns value of the DateFormat option.

      • setTimeZone

        public void setTimeZone​(java.lang.String timeZone)
        The TimeZoneID option is a time zone ID string in the format expected by the TimeZone.getTimeZone(java.lang.String) method.

      • getTimeZone

        public java.lang.String getTimeZone()
        Returns value of the TimeZone option.

      • activateOptions

        public void activateOptions()
        Description copied from interface: OptionHandler
        Activate the options that were previously set with calls to option setters.

        This allows to defer activiation of the options until all options have been set. This is required for components which have related options that remain ambigous until all are set.

        For example, the FileAppender has the File and Append options both of which are ambigous until the other is also set.

      • dateFormat

        public void dateFormat​(java.lang.StringBuffer buf,
                       LoggingEvent event)

      • setDateFormat

        public void setDateFormat​(java.text.DateFormat dateFormat,
                          java.util.TimeZone timeZone)
        Sets the DateFormat used to format time and date in the zone determined by timeZone.