logging-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ggreg...@apache.org
Subject svn commit: r1405287 - /logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/Layout.java
Date Sat, 03 Nov 2012 06:25:30 GMT
Author: ggregory
Date: Sat Nov  3 06:25:30 2012
New Revision: 1405287

URL: http://svn.apache.org/viewvc?rev=1405287&view=rev
Log:
Javadoc.

Modified:
    logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/Layout.java

Modified: logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/Layout.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/Layout.java?rev=1405287&r1=1405286&r2=1405287&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/Layout.java
(original)
+++ logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/Layout.java
Sat Nov  3 06:25:30 2012
@@ -19,11 +19,15 @@ package org.apache.logging.log4j.core;
 import java.io.Serializable;
 
 /**
- * @doubt There is still a need for a character-based layout for character based event sinks
(databases, etc).
- *  Would introduce an EventEncoder, EventRenderer or something similar for the logging event
to byte encoding.
- * (RG) A layout can be configured with a Charset and then Strings can be converted to byte
arrays. OTOH, it isn't
- * possible to write byte arrays as character streams.
- * @param <T> The Object type that will be returned on the {@link #toSerializable(LogEvent)}
call.
+ * Lays out a {@linkplain LogEvent} in different formats. 
+ * The formats are: byte[], or an implementor of {@linkplain Serializable}, like {@code byte[]},
+ * String, and LogEvent.
+ * 
+ * @doubt There is still a need for a character-based layout for character based event sinks
(databases, etc). Would introduce an
+ *        EventEncoder, EventRenderer or something similar for the logging event to byte
encoding. (RG) A layout can be configured with a
+ *        Charset and then Strings can be converted to byte arrays. OTOH, it isn't possible
to write byte arrays as character streams.
+ * @param <T>
+ *            The Object type that will be returned on the {@link #toSerializable(LogEvent)}
call.
  */
 public interface Layout<T extends Serializable> {
     /**



Mime
View raw message