|
Log4j 1.1.3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.log4j.Layout | +--org.apache.log4j.helpers.DateLayout | +--org.apache.log4j.TTCCLayout
TTCC layout format consists of time, thread, category and nested diagnostic context information, hence the name.
Each of the four fields can be individually enabled or
disabled. The time format depends on the DateFormat
used.
Here is an example TTCCLayout output with the RelativeTimeDateFormat
.
176 [main] INFO org.apache.log4j.examples.Sort - Populating an array of 2 elements in reverse order. 225 [main] INFO org.apache.log4j.examples.SortAlgo - Entered the sort method. 262 [main] DEBUG org.apache.log4j.examples.SortAlgo.OUTER i=1 - Outer loop. 276 [main] DEBUG org.apache.log4j.examples.SortAlgo.SWAP i=1 j=0 - Swapping intArray[0] = 1 and intArray[1] = 0 290 [main] DEBUG org.apache.log4j.examples.SortAlgo.OUTER i=0 - Outer loop. 304 [main] INFO org.apache.log4j.examples.SortAlgo.DUMP - Dump of interger array: 317 [main] INFO org.apache.log4j.examples.SortAlgo.DUMP - Element [0] = 0 331 [main] INFO org.apache.log4j.examples.SortAlgo.DUMP - Element [1] = 1 343 [main] INFO org.apache.log4j.examples.Sort - The next log statement should be an error message. 346 [main] ERROR org.apache.log4j.examples.SortAlgo.DUMP - Tried to dump an uninitialized array. at org.apache.log4j.examples.SortAlgo.dump(SortAlgo.java:58) at org.apache.log4j.examples.Sort.main(Sort.java:64) 467 [main] INFO org.apache.log4j.examples.Sort - Exiting main method.
The first field is the number of milliseconds elapsed since the start of the program. The second field is the thread outputting the log statement. The third field is the priority, the fourth field is the category to which the statement belongs.
The fifth field (just before the '-') is the nested diagnostic context. Note the nested diagnostic context may be empty as in the first two statements. The text after the '-' is the message of the statement.
WARNING Do not use the same TTCCLayout instance from within different appenders. The TTCCLayout is not thread safe when used in his way. However, it is perfectly safe to use a TTCCLayout instance from just one appender.
PatternLayout
offers a much more flexible alternative.
Field Summary | |
protected StringBuffer |
buf
|
static String |
CATEGORY_PREFIXING_OPTION
Deprecated. Options are now handled using the JavaBeans paradigm. This constant is not longer needed and will be removed in the near term. |
static String |
CONTEXT_PRINTING_OPTION
Deprecated. Options are now handled using the JavaBeans paradigm. This constant is not longer needed and will be removed in the near term. |
static String |
THREAD_PRINTING_OPTION
Deprecated. Options are now handled using the JavaBeans paradigm. This constant is not longer needed and will be removed in the near term. |
Fields inherited from class org.apache.log4j.helpers.DateLayout |
date, DATE_FORMAT_OPTION, dateFormat, NULL_DATE_FORMAT, pos, RELATIVE_TIME_DATE_FORMAT, TIMEZONE_OPTION |
Fields inherited from class org.apache.log4j.Layout |
LINE_SEP, LINE_SEP_LEN |
Constructor Summary | |
TTCCLayout()
Instantiate a TTCCLayout object with RelativeTimeDateFormat as the date formatter in the local time
zone. |
|
TTCCLayout(String dateFormatType)
Instantiate a TTCCLayout object using the local time zone. |
Method Summary | |
String |
format(LoggingEvent event)
In addition to the priority of the statement and message, the returned byte array includes time, thread, category and NDC
information. |
boolean |
getCategoryPrefixing()
Returns value of the CategoryPrefixing option. |
boolean |
getContextPrinting()
Returns value of the ContextPrinting option. |
String[] |
getOptionStrings()
Return list of strings that the OptionHandler instance recognizes. |
boolean |
getThreadPrinting()
Returns value of the ThreadPrinting option. |
boolean |
ignoresThrowable()
The TTCCLayout does not handle the throwable contained within LoggingEvents . |
void |
setCategoryPrefixing(boolean categoryPrefixing)
The CategoryPrefixing option specifies whether Category
name is part of log output or not. |
void |
setContextPrinting(boolean contextPrinting)
The ContextPrinting option specifies log output will include the nested context information belonging to the current thread. |
void |
setOption(String key,
String value)
Set option to value . |
void |
setThreadPrinting(boolean threadPrinting)
The ThreadPrinting option specifies whether the name of the current thread is part of log output or not. |
Methods inherited from class org.apache.log4j.helpers.DateLayout |
activateOptions, dateFormat, getDateFormat, getTimeZone, setDateFormat, setDateFormat, setDateFormat, setTimeZone |
Methods inherited from class org.apache.log4j.Layout |
getContentType, getFooter, getHeader |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String THREAD_PRINTING_OPTION
public static final String CATEGORY_PREFIXING_OPTION
public static final String CONTEXT_PRINTING_OPTION
protected final StringBuffer buf
Constructor Detail |
public TTCCLayout()
RelativeTimeDateFormat
as the date formatter in the local time
zone.public TTCCLayout(String dateFormatType)
dateFormatType
.
This constructor just calls the DateLayout.setDateFormat(java.lang.String)
method.
Method Detail |
public String[] getOptionStrings()
setOption
method.
OptionHandler
getOptionStrings
in class DateLayout
public void setOption(String key, String value)
setOption
method.
OptionHandler
option
to value
.
The handling of each option depends on the OptionHandler
instance. Some options may become active immediately whereas
other may be activated only when OptionHandler.activateOptions()
is
called.
setOption
in class DateLayout
public void setThreadPrinting(boolean threadPrinting)
public boolean getThreadPrinting()
public void setCategoryPrefixing(boolean categoryPrefixing)
Category
name is part of log output or not. This is true by default.public boolean getCategoryPrefixing()
public void setContextPrinting(boolean contextPrinting)
public boolean getContextPrinting()
public String format(LoggingEvent event)
NDC
information.
Time, thread, category and diagnostic context are printed depending on options.
format
in class Layout
category
- priority
- message
- public boolean ignoresThrowable()
LoggingEvents
. Thus, it returns
true
.ignoresThrowable
in class Layout
|
Log4j 1.1.3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |