Author: rgoers
Date: Sun Sep 18 06:53:02 2011
New Revision: 1172205
URL: http://svn.apache.org/viewvc?rev=1172205&view=rev
Log:
Enhance comments on getThrowable
Modified:
logging/log4j/branches/BRANCH_2_0_EXPERIMENTAL/rgoers/log4j2-api/src/main/java/org/apache/logging/log4j/message/ParameterizedMessage.java
Modified:
logging/log4j/branches/BRANCH_2_0_EXPERIMENTAL/rgoers/log4j2-api/src/main/java/org/apache/logging/log4j/message/ParameterizedMessage.java
URL:
http://svn.apache.org/viewvc/logging/log4j/branches/BRANCH_2_0_EXPERIMENTAL/rgoers/log4j2-api/src/main/java/org/apache/logging/log4j/message/ParameterizedMessage.java?rev=1172205&r1=1172204&r2=1172205&view=diff
==============================================================================
---
logging/log4j/branches/BRANCH_2_0_EXPERIMENTAL/rgoers/log4j2-api/src/main/java/org/apache/logging/log4j/message/ParameterizedMessage.java
(original)
+++
logging/log4j/branches/BRANCH_2_0_EXPERIMENTAL/rgoers/log4j2-api/src/main/java/org/apache/logging/log4j/message/ParameterizedMessage.java
Sun Sep 18 06:53:02 2011
@@ -235,7 +235,10 @@ public class ParameterizedMessage implem
/**
* Returns the Throwable that was given as the last argument, if any.
- * It will not survive serialization.
+ * It will not survive serialization. The Throwable exists as part of the
message
+ * primarily so that it can be extracted from the end of the list of
parameters
+ * and then be added to the LogEvent. As such, the Throwable in the event
should
+ * not be used once the LogEvent has been constructed.
*
* @return the Throwable, if any.
*/
