| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.6.0_33) on Sun Jul 29 12:17:00 PDT 2012 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| ThreadContext (Log4J API 2.0-alpha1 API) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2012-07-29"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ThreadContext (Log4J API 2.0-alpha1 API)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ThreadContext.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/logging/log4j/MarkerManager.html" title="class in org.apache.logging.log4j"><B>PREV CLASS</B></A> |
| NEXT CLASS</FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/logging/log4j/ThreadContext.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="ThreadContext.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.logging.log4j</FONT> |
| <BR> |
| Class ThreadContext</H2> |
| <PRE> |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.logging.log4j.ThreadContext</B> |
| </PRE> |
| <HR> |
| <DL> |
| <DT><PRE>public final class <A HREF="../../../../src-html/org/apache/logging/log4j/ThreadContext.html#line.32"><B>ThreadContext</B></A><DT>extends <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL> |
| </PRE> |
| |
| <P> |
| The ThreadContext allows applications to store information either in a Map |
| <p/> |
| <p><b><em>The MDC is managed on a per thread basis</em></b>. A |
| child thread automatically inherits a <em>copy</em> of the mapped |
| diagnostic context of its parent. |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/logging/log4j/ThreadContext.html#clear()">clear</A></B>()</CODE> |
| |
| <BR> |
| Clear the context.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/logging/log4j/ThreadContext.html#clearStack()">clearStack</A></B>()</CODE> |
| |
| <BR> |
| Clear the stack for this thread.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Stack.html?is-external=true" title="class or interface in java.util">Stack</A><<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/logging/log4j/ThreadContext.html#cloneStack()">cloneStack</A></B>()</CODE> |
| |
| <BR> |
| Return a copy of this thread's stack.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/logging/log4j/ThreadContext.html#containsKey(java.lang.String)">containsKey</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> key)</CODE> |
| |
| <BR> |
| Determine if the key is in the context.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/logging/log4j/ThreadContext.html#get(java.lang.String)">get</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> key)</CODE> |
| |
| <BR> |
| Get the context identified by the <code>key</code> parameter.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/logging/log4j/ThreadContext.html#getContext()">getContext</A></B>()</CODE> |
| |
| <BR> |
| Get the current thread's MDC as a hashtable.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/logging/log4j/ThreadContext.html#getDepth()">getDepth</A></B>()</CODE> |
| |
| <BR> |
| Get the current nesting depth of this thread's stack.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/logging/log4j/ThreadContext.html#peek()">peek</A></B>()</CODE> |
| |
| <BR> |
| Looks at the last diagnostic context at the top of this NDC |
| without removing it.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/logging/log4j/ThreadContext.html#pop()">pop</A></B>()</CODE> |
| |
| <BR> |
| Returns the value of the last item placed on the stack.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/logging/log4j/ThreadContext.html#push(java.lang.String)">push</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> message)</CODE> |
| |
| <BR> |
| Push new diagnostic context information for the current thread.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/logging/log4j/ThreadContext.html#put(java.lang.String, java.lang.String)">put</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> key, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> value)</CODE> |
| |
| <BR> |
| Put a context value (the <code>o</code> parameter) as identified |
| with the <code>key</code> parameter into the current thread's |
| context map.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/logging/log4j/ThreadContext.html#remove(java.lang.String)">remove</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> key)</CODE> |
| |
| <BR> |
| Remove the the context identified by the <code>key</code> |
| parameter.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/logging/log4j/ThreadContext.html#removeStack()">removeStack</A></B>()</CODE> |
| |
| <BR> |
| Remove the diagnostic context for this thread.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/logging/log4j/ThreadContext.html#setMaxDepth(int)">setMaxDepth</A></B>(int maxDepth)</CODE> |
| |
| <BR> |
| Set maximum depth of this diagnostic context.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/logging/log4j/ThreadContext.html#setStack(java.util.Stack)">setStack</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Stack.html?is-external=true" title="class or interface in java.util">Stack</A><<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>> stack)</CODE> |
| |
| <BR> |
| Set this thread's stack.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="put(java.lang.String, java.lang.String)"><!-- --></A><H3> |
| put</H3> |
| <PRE> |
| public static void <A HREF="../../../../src-html/org/apache/logging/log4j/ThreadContext.html#line.64"><B>put</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> key, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> value)</PRE> |
| <DL> |
| <DD>Put a context value (the <code>o</code> parameter) as identified |
| with the <code>key</code> parameter into the current thread's |
| context map. |
| <p/> |
| <p>If the current thread does not have a context map it is |
| created as a side effect. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The key name.<DD><CODE>value</CODE> - The key value.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="get(java.lang.String)"><!-- --></A><H3> |
| get</H3> |
| <PRE> |
| public static <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../../src-html/org/apache/logging/log4j/ThreadContext.html#line.80"><B>get</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> key)</PRE> |
| <DL> |
| <DD>Get the context identified by the <code>key</code> parameter. |
| <p/> |
| <p>This method has no side effects. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The key to locate. |
| <DT><B>Returns:</B><DD>The value associated with the key or null.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="remove(java.lang.String)"><!-- --></A><H3> |
| remove</H3> |
| <PRE> |
| public static void <A HREF="../../../../src-html/org/apache/logging/log4j/ThreadContext.html#line.90"><B>remove</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> key)</PRE> |
| <DL> |
| <DD>Remove the the context identified by the <code>key</code> |
| parameter. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The key to remove.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="clear()"><!-- --></A><H3> |
| clear</H3> |
| <PRE> |
| public static void <A HREF="../../../../src-html/org/apache/logging/log4j/ThreadContext.html#line.100"><B>clear</B></A>()</PRE> |
| <DL> |
| <DD>Clear the context. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="containsKey(java.lang.String)"><!-- --></A><H3> |
| containsKey</H3> |
| <PRE> |
| public static boolean <A HREF="../../../../src-html/org/apache/logging/log4j/ThreadContext.html#line.109"><B>containsKey</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> key)</PRE> |
| <DL> |
| <DD>Determine if the key is in the context. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The key to locate. |
| <DT><B>Returns:</B><DD>True if the key is in the context, false otherwise.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getContext()"><!-- --></A><H3> |
| getContext</H3> |
| <PRE> |
| public static <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>> <A HREF="../../../../src-html/org/apache/logging/log4j/ThreadContext.html#line.119"><B>getContext</B></A>()</PRE> |
| <DL> |
| <DD>Get the current thread's MDC as a hashtable. This method is |
| intended to be used internally. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>a copy of the context.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="clearStack()"><!-- --></A><H3> |
| clearStack</H3> |
| <PRE> |
| public static void <A HREF="../../../../src-html/org/apache/logging/log4j/ThreadContext.html#line.127"><B>clearStack</B></A>()</PRE> |
| <DL> |
| <DD>Clear the stack for this thread. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="cloneStack()"><!-- --></A><H3> |
| cloneStack</H3> |
| <PRE> |
| public static <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Stack.html?is-external=true" title="class or interface in java.util">Stack</A><<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>> <A HREF="../../../../src-html/org/apache/logging/log4j/ThreadContext.html#line.135"><B>cloneStack</B></A>()</PRE> |
| <DL> |
| <DD>Return a copy of this thread's stack. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>A copy of this thread's stack.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setStack(java.util.Stack)"><!-- --></A><H3> |
| setStack</H3> |
| <PRE> |
| public static void <A HREF="../../../../src-html/org/apache/logging/log4j/ThreadContext.html#line.144"><B>setStack</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Stack.html?is-external=true" title="class or interface in java.util">Stack</A><<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>> stack)</PRE> |
| <DL> |
| <DD>Set this thread's stack. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>stack</CODE> - The stack to use.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDepth()"><!-- --></A><H3> |
| getDepth</H3> |
| <PRE> |
| public static int <A HREF="../../../../src-html/org/apache/logging/log4j/ThreadContext.html#line.154"><B>getDepth</B></A>()</PRE> |
| <DL> |
| <DD>Get the current nesting depth of this thread's stack. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the number of items in the stack.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/logging/log4j/ThreadContext.html#setMaxDepth(int)"><CODE>setMaxDepth(int)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="pop()"><!-- --></A><H3> |
| pop</H3> |
| <PRE> |
| public static <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../../src-html/org/apache/logging/log4j/ThreadContext.html#line.167"><B>pop</B></A>()</PRE> |
| <DL> |
| <DD>Returns the value of the last item placed on the stack. |
| <p/> |
| <p>The returned value is the value that was pushed last. If no |
| context is available, then the empty string "" is returned. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>String The innermost diagnostic context.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="peek()"><!-- --></A><H3> |
| peek</H3> |
| <PRE> |
| public static <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../../src-html/org/apache/logging/log4j/ThreadContext.html#line.184"><B>peek</B></A>()</PRE> |
| <DL> |
| <DD>Looks at the last diagnostic context at the top of this NDC |
| without removing it. |
| <p/> |
| <p>The returned value is the value that was pushed last. If no |
| context is available, then the empty string "" is returned. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>String The innermost diagnostic context.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="push(java.lang.String)"><!-- --></A><H3> |
| push</H3> |
| <PRE> |
| public static void <A HREF="../../../../src-html/org/apache/logging/log4j/ThreadContext.html#line.200"><B>push</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> message)</PRE> |
| <DL> |
| <DD>Push new diagnostic context information for the current thread. |
| <p/> |
| <p>The contents of the <code>message</code> parameter is |
| determined solely by the client. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>message</CODE> - The new diagnostic context information.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeStack()"><!-- --></A><H3> |
| removeStack</H3> |
| <PRE> |
| public static void <A HREF="../../../../src-html/org/apache/logging/log4j/ThreadContext.html#line.226"><B>removeStack</B></A>()</PRE> |
| <DL> |
| <DD>Remove the diagnostic context for this thread. |
| <p/> |
| <p>Each thread that created a diagnostic context by calling |
| <A HREF="../../../../org/apache/logging/log4j/ThreadContext.html#push(java.lang.String)"><CODE>push(java.lang.String)</CODE></A> should call this method before exiting. Otherwise, |
| the memory used by the <b>thread</b> cannot be reclaimed by the |
| VM. |
| <p/> |
| <p>As this is such an important problem in heavy duty systems and |
| because it is difficult to always guarantee that the remove |
| method is called before exiting a thread, this method has been |
| augmented to lazily remove references to dead threads. In |
| practice, this means that you can be a little sloppy and |
| occasionally forget to call <A HREF="../../../../org/apache/logging/log4j/ThreadContext.html#remove(java.lang.String)"><CODE>remove(java.lang.String)</CODE></A> before exiting a |
| thread. However, you must call <code>remove</code> sometime. If |
| you never call it, then your application is sure to run out of |
| memory. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setMaxDepth(int)"><!-- --></A><H3> |
| setMaxDepth</H3> |
| <PRE> |
| public static void <A HREF="../../../../src-html/org/apache/logging/log4j/ThreadContext.html#line.258"><B>setMaxDepth</B></A>(int maxDepth)</PRE> |
| <DL> |
| <DD>Set maximum depth of this diagnostic context. If the current |
| depth is smaller or equal to <code>maxDepth</code>, then no |
| action is taken. |
| <p/> |
| <p>This method is a convenient alternative to multiple <A HREF="../../../../org/apache/logging/log4j/ThreadContext.html#pop()"><CODE>pop()</CODE></A> calls. Moreover, it is often the case that at the end of |
| complex call sequences, the depth of the NDC is |
| unpredictable. The <code>setMaxDepth</code> method circumvents |
| this problem. |
| <p/> |
| <p>For example, the combination |
| <pre> |
| void foo() { |
| int depth = NDC.getDepth(); |
| <p/> |
| ... complex sequence of calls |
| <p/> |
| NDC.setMaxDepth(depth); |
| } |
| </pre> |
| <p/> |
| ensures that between the entry and exit of foo the depth of the |
| diagnostic stack is conserved. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>maxDepth</CODE> - The maximum depth of the stack.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/logging/log4j/ThreadContext.html#getDepth()"><CODE>getDepth()</CODE></A></DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ThreadContext.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/logging/log4j/MarkerManager.html" title="class in org.apache.logging.log4j"><B>PREV CLASS</B></A> |
| NEXT CLASS</FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/logging/log4j/ThreadContext.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="ThreadContext.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 1999-2012 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved. Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, and the Apache Logging project logo are trademarks of The Apache Software Foundation. |
| </BODY> |
| </HTML> |
