Author: rgoers
Date: Sun Jul 22 20:07:50 2012
New Revision: 1364421
URL: http://svn.apache.org/viewvc?rev=1364421&view=rev
Log:
Add more details to the javadoc
Modified:
logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/message/FormattedMessage.java
Modified:
logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/message/FormattedMessage.java
URL:
http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/message/FormattedMessage.java?rev=1364421&r1=1364420&r2=1364421&view=diff
==============================================================================
---
logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/message/FormattedMessage.java
(original)
+++
logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/message/FormattedMessage.java
Sun Jul 22 20:07:50 2012
@@ -17,7 +17,10 @@
package org.apache.logging.log4j.message;
/**
- * A Message that can have a format String attached to it.
+ * A Message that can have a format String attached to it. The format string
is used by the
+ * Message implementation as extra information that it may use to help it to
determine how
+ * to format itself. For example, MapMessage accepts a format of "XML" to tell
it to render
+ * the Map as XML instead of its default format of {key1="value1"
key2="value2"}.
*/
public interface FormattedMessage extends Message {
/**
