From commits-return-1799-apmail-logging-commits-archive=logging.apache.org@logging.apache.org Wed Dec 12 19:49:51 2012 Return-Path: X-Original-To: apmail-logging-commits-archive@minotaur.apache.org Delivered-To: apmail-logging-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id BFFC8DBA7 for ; Wed, 12 Dec 2012 19:49:51 +0000 (UTC) Received: (qmail 68090 invoked by uid 500); 12 Dec 2012 19:49:51 -0000 Delivered-To: apmail-logging-commits-archive@logging.apache.org Received: (qmail 68070 invoked by uid 500); 12 Dec 2012 19:49:51 -0000 Mailing-List: contact commits-help@logging.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@logging.apache.org Delivered-To: mailing list commits@logging.apache.org Received: (qmail 68059 invoked by uid 99); 12 Dec 2012 19:49:51 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 12 Dec 2012 19:49:51 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 12 Dec 2012 19:49:50 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id 74D1923888E7; Wed, 12 Dec 2012 19:49:30 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1420933 - /logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/Layout.java Date: Wed, 12 Dec 2012 19:49:30 -0000 To: commits@logging.apache.org From: ggregory@apache.org X-Mailer: svnmailer-1.0.8-patched Message-Id: <20121212194930.74D1923888E7@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: ggregory Date: Wed Dec 12 19:49:27 2012 New Revision: 1420933 URL: http://svn.apache.org/viewvc?rev=1420933&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=1420933&r1=1420932&r2=1420933&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 Wed Dec 12 19:49:27 2012 @@ -19,15 +19,26 @@ package org.apache.logging.log4j.core; import java.io.Serializable; /** - * Lays out a {@linkplain LogEvent} in different formats. - * The formats are: byte[], or an implementor of {@linkplain Serializable}, like {@code byte[]}, - * String, and LogEvent. + * Lays out a {@linkplain LogEvent} in different formats. * + * The formats are: + *
    + *
  • + * {@code byte[]}
    • + *
  • + * an implementor of {@linkplain Serializable}, like {@code byte[]}
    • + *
  • + * {@linkplain String}
    • + *
  • + * {@linkplain LogEvent}
    • + *
+ * + * @param + * The type returned by {@link #toSerializable(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 - * The Object type that will be returned on the {@link #toSerializable(LogEvent)} call. */ public interface Layout { /**