/apache-log4j-1.2.17/site/apidocs/org/apache/log4j/pattern/class-use/LoggingEventPatternConverter.html
HTML | 322 lines | 269 code | 37 blank | 16 comment | 0 complexity | 97f749b3e99775bee6158b3cc845459e MD5 | raw file
Possible License(s): Apache-2.0
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.6.0_23) -->
6<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
7<TITLE>
8Uses of Class org.apache.log4j.pattern.LoggingEventPatternConverter (Apache Log4j 1.2.17 API)
9</TITLE>
10
11<META NAME="date" CONTENT="2012-05-06">
12
13<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
14
15<SCRIPT type="text/javascript">
16function windowTitle()
17{
18 if (location.href.indexOf('is-external=true') == -1) {
19 parent.document.title="Uses of Class org.apache.log4j.pattern.LoggingEventPatternConverter (Apache Log4j 1.2.17 API)";
20 }
21}
22</SCRIPT>
23<NOSCRIPT>
24</NOSCRIPT>
25
26</HEAD>
27
28<BODY BGCOLOR="white" onload="windowTitle();">
29<HR>
30
31
32<!-- ========= START OF TOP NAVBAR ======= -->
33<A NAME="navbar_top"><!-- --></A>
34<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
35<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
36<TR>
37<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
38<A NAME="navbar_top_firstrow"><!-- --></A>
39<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
40 <TR ALIGN="center" VALIGN="top">
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../org/apache/log4j/pattern/LoggingEventPatternConverter.html" title="class in org.apache.log4j.pattern"><FONT CLASS="NavBarFont1"><B>Class</B></FONT></A> </TD>
44 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Use</B></FONT> </TD>
45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
48 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
49 </TR>
50</TABLE>
51</TD>
52<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
53</EM>
54</TD>
55</TR>
56
57<TR>
58<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
59 PREV
60 NEXT</FONT></TD>
61<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
62 <A HREF="../../../../../index.html?org/apache/log4j/pattern//class-useLoggingEventPatternConverter.html" target="_top"><B>FRAMES</B></A>
63 <A HREF="LoggingEventPatternConverter.html" target="_top"><B>NO FRAMES</B></A>
64 <SCRIPT type="text/javascript">
65 <!--
66 if(window==top) {
67 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
68 }
69 //-->
70</SCRIPT>
71<NOSCRIPT>
72 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
73</NOSCRIPT>
74
75
76</FONT></TD>
77</TR>
78</TABLE>
79<A NAME="skip-navbar_top"></A>
80<!-- ========= END OF TOP NAVBAR ========= -->
81
82<HR>
83<CENTER>
84<H2>
85<B>Uses of Class<br>org.apache.log4j.pattern.LoggingEventPatternConverter</B></H2>
86</CENTER>
87
88<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
89<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
90<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
91Packages that use <A HREF="../../../../../org/apache/log4j/pattern/LoggingEventPatternConverter.html" title="class in org.apache.log4j.pattern">LoggingEventPatternConverter</A></FONT></TH>
92</TR>
93<TR BGCOLOR="white" CLASS="TableRowColor">
94<TD><A HREF="#org.apache.log4j.pattern"><B>org.apache.log4j.pattern</B></A></TD>
95<TD>Provides classes implementing format specifiers in conversion patterns. </TD>
96</TR>
97</TABLE>
98
99<P>
100<A NAME="org.apache.log4j.pattern"><!-- --></A>
101<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
102<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
103<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
104Uses of <A HREF="../../../../../org/apache/log4j/pattern/LoggingEventPatternConverter.html" title="class in org.apache.log4j.pattern">LoggingEventPatternConverter</A> in <A HREF="../../../../../org/apache/log4j/pattern/package-summary.html">org.apache.log4j.pattern</A></FONT></TH>
105</TR>
106</TABLE>
107
108<P>
109
110<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
111<TR BGCOLOR="#CCCCFF" CLASS="TableSubHeadingColor">
112<TH ALIGN="left" COLSPAN="2">Subclasses of <A HREF="../../../../../org/apache/log4j/pattern/LoggingEventPatternConverter.html" title="class in org.apache.log4j.pattern">LoggingEventPatternConverter</A> in <A HREF="../../../../../org/apache/log4j/pattern/package-summary.html">org.apache.log4j.pattern</A></FONT></TH>
113</TR>
114<TR BGCOLOR="white" CLASS="TableRowColor">
115<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
116<CODE> class</CODE></FONT></TD>
117<TD><CODE><B><A HREF="../../../../../org/apache/log4j/pattern/ClassNamePatternConverter.html" title="class in org.apache.log4j.pattern">ClassNamePatternConverter</A></B></CODE>
118
119<BR>
120 Formats the class name of the site of the logging request.</TD>
121</TR>
122<TR BGCOLOR="white" CLASS="TableRowColor">
123<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
124<CODE> class</CODE></FONT></TD>
125<TD><CODE><B><A HREF="../../../../../org/apache/log4j/pattern/DatePatternConverter.html" title="class in org.apache.log4j.pattern">DatePatternConverter</A></B></CODE>
126
127<BR>
128 Convert and format the event's date in a StringBuffer.</TD>
129</TR>
130<TR BGCOLOR="white" CLASS="TableRowColor">
131<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
132<CODE> class</CODE></FONT></TD>
133<TD><CODE><B><A HREF="../../../../../org/apache/log4j/pattern/FileLocationPatternConverter.html" title="class in org.apache.log4j.pattern">FileLocationPatternConverter</A></B></CODE>
134
135<BR>
136 Return the event's line location information in a StringBuffer.</TD>
137</TR>
138<TR BGCOLOR="white" CLASS="TableRowColor">
139<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
140<CODE> class</CODE></FONT></TD>
141<TD><CODE><B><A HREF="../../../../../org/apache/log4j/pattern/FullLocationPatternConverter.html" title="class in org.apache.log4j.pattern">FullLocationPatternConverter</A></B></CODE>
142
143<BR>
144 Format the event's line location information.</TD>
145</TR>
146<TR BGCOLOR="white" CLASS="TableRowColor">
147<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
148<CODE> class</CODE></FONT></TD>
149<TD><CODE><B><A HREF="../../../../../org/apache/log4j/pattern/LevelPatternConverter.html" title="class in org.apache.log4j.pattern">LevelPatternConverter</A></B></CODE>
150
151<BR>
152 Return the event's level in a StringBuffer.</TD>
153</TR>
154<TR BGCOLOR="white" CLASS="TableRowColor">
155<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
156<CODE> class</CODE></FONT></TD>
157<TD><CODE><B><A HREF="../../../../../org/apache/log4j/pattern/LineLocationPatternConverter.html" title="class in org.apache.log4j.pattern">LineLocationPatternConverter</A></B></CODE>
158
159<BR>
160 Return the event's line location information in a StringBuffer.</TD>
161</TR>
162<TR BGCOLOR="white" CLASS="TableRowColor">
163<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
164<CODE> class</CODE></FONT></TD>
165<TD><CODE><B><A HREF="../../../../../org/apache/log4j/pattern/LineSeparatorPatternConverter.html" title="class in org.apache.log4j.pattern">LineSeparatorPatternConverter</A></B></CODE>
166
167<BR>
168 Formats a line separator.</TD>
169</TR>
170<TR BGCOLOR="white" CLASS="TableRowColor">
171<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
172<CODE> class</CODE></FONT></TD>
173<TD><CODE><B><A HREF="../../../../../org/apache/log4j/pattern/LiteralPatternConverter.html" title="class in org.apache.log4j.pattern">LiteralPatternConverter</A></B></CODE>
174
175<BR>
176 Formats a string literal.</TD>
177</TR>
178<TR BGCOLOR="white" CLASS="TableRowColor">
179<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
180<CODE> class</CODE></FONT></TD>
181<TD><CODE><B><A HREF="../../../../../org/apache/log4j/pattern/LoggerPatternConverter.html" title="class in org.apache.log4j.pattern">LoggerPatternConverter</A></B></CODE>
182
183<BR>
184 Formats a logger name.</TD>
185</TR>
186<TR BGCOLOR="white" CLASS="TableRowColor">
187<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
188<CODE> class</CODE></FONT></TD>
189<TD><CODE><B><A HREF="../../../../../org/apache/log4j/pattern/MessagePatternConverter.html" title="class in org.apache.log4j.pattern">MessagePatternConverter</A></B></CODE>
190
191<BR>
192 Return the event's rendered message in a StringBuffer.</TD>
193</TR>
194<TR BGCOLOR="white" CLASS="TableRowColor">
195<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
196<CODE> class</CODE></FONT></TD>
197<TD><CODE><B><A HREF="../../../../../org/apache/log4j/pattern/MethodLocationPatternConverter.html" title="class in org.apache.log4j.pattern">MethodLocationPatternConverter</A></B></CODE>
198
199<BR>
200 Return the event's line location information in a StringBuffer.</TD>
201</TR>
202<TR BGCOLOR="white" CLASS="TableRowColor">
203<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
204<CODE> class</CODE></FONT></TD>
205<TD><CODE><B><A HREF="../../../../../org/apache/log4j/pattern/NamePatternConverter.html" title="class in org.apache.log4j.pattern">NamePatternConverter</A></B></CODE>
206
207<BR>
208 Base class for other pattern converters which can return only parts of their name.</TD>
209</TR>
210<TR BGCOLOR="white" CLASS="TableRowColor">
211<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
212<CODE> class</CODE></FONT></TD>
213<TD><CODE><B><A HREF="../../../../../org/apache/log4j/pattern/NDCPatternConverter.html" title="class in org.apache.log4j.pattern">NDCPatternConverter</A></B></CODE>
214
215<BR>
216 Return the event's NDC in a StringBuffer.</TD>
217</TR>
218<TR BGCOLOR="white" CLASS="TableRowColor">
219<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
220<CODE> class</CODE></FONT></TD>
221<TD><CODE><B><A HREF="../../../../../org/apache/log4j/pattern/PropertiesPatternConverter.html" title="class in org.apache.log4j.pattern">PropertiesPatternConverter</A></B></CODE>
222
223<BR>
224 Able to handle the contents of the LoggingEvent's Property bundle and either
225 output the entire contents of the properties in a similar format to the
226 java.util.Hashtable.toString(), or to output the value of a specific key
227 within the property bundle
228 when this pattern converter has the option set.</TD>
229</TR>
230<TR BGCOLOR="white" CLASS="TableRowColor">
231<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
232<CODE> class</CODE></FONT></TD>
233<TD><CODE><B><A HREF="../../../../../org/apache/log4j/pattern/RelativeTimePatternConverter.html" title="class in org.apache.log4j.pattern">RelativeTimePatternConverter</A></B></CODE>
234
235<BR>
236 Return the relative time in milliseconds since loading of the LoggingEvent
237 class.</TD>
238</TR>
239<TR BGCOLOR="white" CLASS="TableRowColor">
240<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
241<CODE> class</CODE></FONT></TD>
242<TD><CODE><B><A HREF="../../../../../org/apache/log4j/pattern/SequenceNumberPatternConverter.html" title="class in org.apache.log4j.pattern">SequenceNumberPatternConverter</A></B></CODE>
243
244<BR>
245 Formats the event sequence number.</TD>
246</TR>
247<TR BGCOLOR="white" CLASS="TableRowColor">
248<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
249<CODE> class</CODE></FONT></TD>
250<TD><CODE><B><A HREF="../../../../../org/apache/log4j/pattern/ThreadPatternConverter.html" title="class in org.apache.log4j.pattern">ThreadPatternConverter</A></B></CODE>
251
252<BR>
253 Formats the event thread name.</TD>
254</TR>
255<TR BGCOLOR="white" CLASS="TableRowColor">
256<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
257<CODE> class</CODE></FONT></TD>
258<TD><CODE><B><A HREF="../../../../../org/apache/log4j/pattern/ThrowableInformationPatternConverter.html" title="class in org.apache.log4j.pattern">ThrowableInformationPatternConverter</A></B></CODE>
259
260<BR>
261 Outputs the ThrowableInformation portion of the LoggingEvent.</TD>
262</TR>
263</TABLE>
264
265<P>
266<HR>
267
268
269<!-- ======= START OF BOTTOM NAVBAR ====== -->
270<A NAME="navbar_bottom"><!-- --></A>
271<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
272<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
273<TR>
274<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
275<A NAME="navbar_bottom_firstrow"><!-- --></A>
276<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
277 <TR ALIGN="center" VALIGN="top">
278 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
279 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
280 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../org/apache/log4j/pattern/LoggingEventPatternConverter.html" title="class in org.apache.log4j.pattern"><FONT CLASS="NavBarFont1"><B>Class</B></FONT></A> </TD>
281 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Use</B></FONT> </TD>
282 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
283 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
284 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
285 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
286 </TR>
287</TABLE>
288</TD>
289<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
290</EM>
291</TD>
292</TR>
293
294<TR>
295<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
296 PREV
297 NEXT</FONT></TD>
298<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
299 <A HREF="../../../../../index.html?org/apache/log4j/pattern//class-useLoggingEventPatternConverter.html" target="_top"><B>FRAMES</B></A>
300 <A HREF="LoggingEventPatternConverter.html" target="_top"><B>NO FRAMES</B></A>
301 <SCRIPT type="text/javascript">
302 <!--
303 if(window==top) {
304 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
305 }
306 //-->
307</SCRIPT>
308<NOSCRIPT>
309 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
310</NOSCRIPT>
311
312
313</FONT></TD>
314</TR>
315</TABLE>
316<A NAME="skip-navbar_bottom"></A>
317<!-- ======== END OF BOTTOM NAVBAR ======= -->
318
319<HR>
320Copyright © 1999-2012 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.
321</BODY>
322</HTML>