Author: rgoers Date: Mon Jul 23 05:03:53 2012 New Revision: 1364496 URL: http://svn.apache.org/viewvc?rev=1364496&view=rev Log: Adding more content to the javadoc.
Modified: logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/message/Message.java Modified: logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/message/Message.java URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/message/Message.java?rev=1364496&r1=1364495&r2=1364496&view=diff ============================================================================== --- logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/message/Message.java (original) +++ logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/message/Message.java Mon Jul 23 05:03:53 2012 @@ -37,7 +37,9 @@ import java.io.Serializable; */ public interface Message extends Serializable { /** - * Returns the Message formatted as a String. + * Returns the Message formatted as a String. Each Message implementation determines the + * appropriate way to format the data encapsulated in the Message. Messages that provide + * more than one way of formatting the Message will implement MultiformatMessage. * * @return The message String. */ @@ -46,7 +48,8 @@ public interface Message extends Seriali /** * Returns the format portion of the Message. * - * @return The message format. + * @return The message format. Some implementations, such as ParameterizedMessage, will use this as + * the message "pattern". Other Messages may simply return an empty String. * @doubt Do all messages have a format? What syntax? Using a Formatter object could be cleaner. * (RG) In SimpleMessage the format is identical to the formatted message. In ParameterizedMessage and * StructuredDataMessage it is not. It is up to the Message implementer to determine what this