Mailing-List: contact commits-help@logging.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@logging.apache.org
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: svn commit: r1558494 -
 /logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/LogEvent.java
Date: Wed, 15 Jan 2014 18:16:39 -0000
To: commits@logging.apache.org
From: ggregory@apache.org
Message-Id: <20140115181639.E5FB12388A5B@eris.apache.org>

Author: ggregory
Date: Wed Jan 15 18:16:39 2014
New Revision: 1558494

URL: http://svn.apache.org/r1558494
Log:
Format.

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

Modified: logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/LogEvent.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/LogEvent.java?rev=1558494&r1=1558493&r2=1558494&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/LogEvent.java (original)
+++ logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/LogEvent.java Wed Jan 15 18:16:39 2014
@@ -30,53 +30,55 @@ import org.apache.logging.log4j.message.
  */
 public interface LogEvent extends Serializable {
 
-     /**
+    /**
      * Gets the MDC data.
-     *
+     * 
      * @return A copy of the Mapped Diagnostic Context or null.
      */
     Map<String, String> getContextMap();
 
     /**
      * Gets the NDC data.
-     *
+     * 
      * @return A copy of the Nested Diagnostic Context or null;
      */
     ThreadContext.ContextStack getContextStack();
 
     /**
      * Returns the fully qualified class name of the caller of the logging api.
+     * 
      * @return The fully qualified class name of the caller.
      */
     String getFQCN();
 
     /**
      * Gets the level.
+     * 
      * @return level.
      */
     Level getLevel();
 
     /**
      * Gets the logger name.
+     * 
      * @return logger name, may be null.
      */
     String getLoggerName();
 
     /**
      * Gets the Marker associated with the event.
+     * 
      * @return Marker
      */
     Marker getMarker();
 
-
     /**
      * Gets the message associated with the event.
-     *
+     * 
      * @return message.
      */
     Message getMessage();
 
-
     /**
      * Gets event time in milliseconds since midnight, January 1, 1970 UTC.
      * 
@@ -85,67 +87,66 @@ public interface LogEvent extends Serial
      */
     long getMillis();
 
-
     /**
      * Gets the source of logging request.
+     * 
      * @return source of logging request, may be null.
      */
     StackTraceElement getSource();
 
     /**
      * Gets thread name.
+     * 
      * @return thread name, may be null.
-     * @doubt guess this could go into a thread context object too.
-     * (RG) Why?
+     * @doubt guess this could go into a thread context object too. (RG) Why?
      */
     String getThreadName();
 
     /**
      * Gets throwable associated with logging request.
+     * 
      * @return throwable, may be null.
      */
     Throwable getThrown();
 
     /**
-     * Returns {@code true} if this event is the last one in a batch,
-     * {@code false} otherwise. Used by asynchronous Loggers and Appenders to
-     * signal to buffered downstream components when to flush to disk, as a
-     * more efficient alternative to the {@code immediateFlush=true}
-     * configuration.
+     * Returns {@code true} if this event is the last one in a batch, {@code false} otherwise. Used by asynchronous
+     * Loggers and Appenders to signal to buffered downstream components when to flush to disk, as a more efficient
+     * alternative to the {@code immediateFlush=true} configuration.
+     * 
      * @return whether this event is the last one in a batch.
      */
     // see also LOG4J2-164
     boolean isEndOfBatch();
 
     /**
-     * Returns whether the source of the logging request is required downstream.
-     * Asynchronous Loggers and Appenders use this flag to determine whether
-     * to take a {@code StackTrace} snapshot or not before handing off this
-     * event to another thread.
-     * @return {@code true} if the source of the logging request is required
-     *          downstream, {@code false} otherwise.
+     * Returns whether the source of the logging request is required downstream. Asynchronous Loggers and Appenders use
+     * this flag to determine whether to take a {@code StackTrace} snapshot or not before handing off this event to
+     * another thread.
+     * 
+     * @return {@code true} if the source of the logging request is required downstream, {@code false} otherwise.
      * @see #getSource()
      */
     // see also LOG4J2-153
     boolean isIncludeLocation();
 
     /**
-     * Sets whether this event is the last one in a batch.
-     * Used by asynchronous Loggers and Appenders to signal to buffered
-     * downstream components when to flush to disk, as a more efficient
-     * alternative to the {@code immediateFlush=true} configuration.
-     * @param endOfBatch {@code true} if this event is the last one in a batch,
-     * {@code false} otherwise.
+     * Sets whether this event is the last one in a batch. Used by asynchronous Loggers and Appenders to signal to
+     * buffered downstream components when to flush to disk, as a more efficient alternative to the
+     * {@code immediateFlush=true} configuration.
+     * 
+     * @param endOfBatch
+     *            {@code true} if this event is the last one in a batch, {@code false} otherwise.
      */
     void setEndOfBatch(boolean endOfBatch);
 
     /**
-     * Sets whether the source of the logging request is required downstream.
-     * Asynchronous Loggers and Appenders use this flag to determine whether
-     * to take a {@code StackTrace} snapshot or not before handing off this
-     * event to another thread.
-     * @param locationRequired {@code true} if the source of the logging request
-     *           is required downstream, {@code false} otherwise.
+     * Sets whether the source of the logging request is required downstream. Asynchronous Loggers and Appenders use
+     * this flag to determine whether to take a {@code StackTrace} snapshot or not before handing off this event to
+     * another thread.
+     * 
+     * @param locationRequired
+     *            {@code true} if the source of the logging request is required downstream, {@code false} otherwise.
      * @see #getSource()
      */
     void setIncludeLocation(boolean locationRequired);