Repository: logging-log4j2
Updated Branches:
  refs/heads/master 431f9df31 -> b4fb66476


LOG4J2-1447 LOG4J2-1349 javadoc


Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo
Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/b4fb6647
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/b4fb6647
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/b4fb6647

Branch: refs/heads/master
Commit: b4fb66476a0c4a4b9ef3bf1941eee99b43bfa184
Parents: 431f9df
Author: rpopma <rpo...@apache.org>
Authored: Fri Sep 23 01:14:13 2016 +0900
Committer: rpopma <rpo...@apache.org>
Committed: Fri Sep 23 01:14:13 2016 +0900

----------------------------------------------------------------------
 .../apache/logging/log4j/util/ContextData.java  | 23 ++++++--------------
 .../logging/log4j/util/MutableContextData.java  | 10 ++++-----
 2 files changed, 12 insertions(+), 21 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/b4fb6647/log4j-api/src/main/java/org/apache/logging/log4j/util/ContextData.java
----------------------------------------------------------------------
diff --git 
a/log4j-api/src/main/java/org/apache/logging/log4j/util/ContextData.java 
b/log4j-api/src/main/java/org/apache/logging/log4j/util/ContextData.java
index ad440a0..f580a75 100644
--- a/log4j-api/src/main/java/org/apache/logging/log4j/util/ContextData.java
+++ b/log4j-api/src/main/java/org/apache/logging/log4j/util/ContextData.java
@@ -19,33 +19,24 @@ package org.apache.logging.log4j.util;
 import java.io.Serializable;
 import java.util.Map;
 
-import org.apache.logging.log4j.util.BiConsumer;
-import org.apache.logging.log4j.util.TriConsumer;
-
 /**
- * A read-only collection of context data. Context data items are String keys 
and values of arbitrary type that are
- * set by the application to be included in all subsequent log events. A 
typical source of context data is the
- * {@code ThreadContextMap} and the {@code Properties} defined in the 
configuration.
- * <p>
- * Applications can put custom data in this collection by installing a custom 
{@code ContextDataInjector}.
- * </p>
+ * A read-only collection of String keys and values of arbitrary type.
  *
- * @see org.apache.logging.log4j.spi.ThreadContextMap
  * @since 2.7
  */
 public interface ContextData extends Serializable {
     /**
-     * Returns a non-{@code null} mutable {@code Map<String, String>} 
containing a snapshot of this context data.
+     * Returns a non-{@code null} mutable {@code Map<String, String>} 
containing a snapshot of this data structure.
      *
-     * @return a mutable copy of this context data in {@code Map<String, 
String>} form
+     * @return a mutable copy of this data structure in {@code Map<String, 
String>} form
      */
     Map<String, String> toMap();
 
     /**
-     * Returns {@code true} if this context data contains the specified key, 
{@code false} otherwise.
+     * Returns {@code true} if this data structure contains the specified key, 
{@code false} otherwise.
      *
      * @param key the key whose presence to check. May be {@code null}.
-     * @return {@code true} if this context data contains the specified key, 
{@code false} otherwise
+     * @return {@code true} if this data structure contains the specified key, 
{@code false} otherwise
      */
     boolean containsKey(String key);
 
@@ -62,7 +53,7 @@ public interface ContextData extends Serializable {
      * @param action The action to be performed for each key-value pair in 
this collection
      * @param <V> type of the value
      * @throws java.util.ConcurrentModificationException some implementations 
may not support structural modifications
-     *          to this context data while iterating over the contents with 
{@link #forEach(BiConsumer)} or
+     *          to this data structure while iterating over the contents with 
{@link #forEach(BiConsumer)} or
      *          {@link #forEach(TriConsumer, Object)}.
      */
     <V> void forEach(final BiConsumer<String, ? super V> action);
@@ -87,7 +78,7 @@ public interface ContextData extends Serializable {
      * @param <V> type of the value
      * @param <S> type of the third parameter
      * @throws java.util.ConcurrentModificationException some implementations 
may not support structural modifications
-     *          to this context data while iterating over the contents with 
{@link #forEach(BiConsumer)} or
+     *          to this data structure while iterating over the contents with 
{@link #forEach(BiConsumer)} or
      *          {@link #forEach(TriConsumer, Object)}.
      */
     <V, S> void forEach(final TriConsumer<String, ? super V, S> action, final 
S state);

http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/b4fb6647/log4j-api/src/main/java/org/apache/logging/log4j/util/MutableContextData.java
----------------------------------------------------------------------
diff --git 
a/log4j-api/src/main/java/org/apache/logging/log4j/util/MutableContextData.java 
b/log4j-api/src/main/java/org/apache/logging/log4j/util/MutableContextData.java
index cde3874..3a08fe4 100644
--- 
a/log4j-api/src/main/java/org/apache/logging/log4j/util/MutableContextData.java
+++ 
b/log4j-api/src/main/java/org/apache/logging/log4j/util/MutableContextData.java
@@ -27,7 +27,7 @@ public interface MutableContextData extends ContextData {
     /**
      * Removes all key-value pairs from this collection.
      * @throws java.util.ConcurrentModificationException some implementations 
may not support structural modifications
-     *          to this context data while iterating over the contents with 
{@link #forEach(BiConsumer)} or
+     *          to this data structure while iterating over the contents with 
{@link #forEach(BiConsumer)} or
      *          {@link #forEach(TriConsumer, Object)}.
      * @throws UnsupportedOperationException if this collection has been 
{@linkplain #isFrozen() frozen}.
      */
@@ -67,7 +67,7 @@ public interface MutableContextData extends ContextData {
      * Copy all key-value pairs from the specified {@code ContextData} into 
this {@code MutableContextData}.
      * @param source the {@code ContextData} to copy key-value pairs from
      * @throws java.util.ConcurrentModificationException some implementations 
may not support structural modifications
-     *          to this context data while iterating over the contents with 
{@link #forEach(BiConsumer)} or
+     *          to this data structure while iterating over the contents with 
{@link #forEach(BiConsumer)} or
      *          {@link #forEach(TriConsumer, Object)}.
      * @throws UnsupportedOperationException if this collection has been 
{@linkplain #isFrozen() frozen}.
      */
@@ -79,18 +79,18 @@ public interface MutableContextData extends ContextData {
      * @param key the key to add or remove. Keys may be {@code null}.
      * @param value the value to add. Values may be {@code null}.
      * @throws java.util.ConcurrentModificationException some implementations 
may not support structural modifications
-     *          to this context data while iterating over the contents with 
{@link #forEach(BiConsumer)} or
+     *          to this data structure while iterating over the contents with 
{@link #forEach(BiConsumer)} or
      *          {@link #forEach(TriConsumer, Object)}.
      * @throws UnsupportedOperationException if this collection has been 
{@linkplain #isFrozen() frozen}.
      */
     void putValue(final String key, final Object value);
 
     /**
-     * Removes the key-value pair for the specified key from this context data 
collection.
+     * Removes the key-value pair for the specified key from this data 
structure.
      *
      * @param key the key to remove. May be {@code null}.
      * @throws java.util.ConcurrentModificationException some implementations 
may not support structural modifications
-     *          to this context data while iterating over the contents with 
{@link #forEach(BiConsumer)} or
+     *          to this data structure while iterating over the contents with 
{@link #forEach(BiConsumer)} or
      *          {@link #forEach(TriConsumer, Object)}.
      * @throws UnsupportedOperationException if this collection has been 
{@linkplain #isFrozen() frozen}.
      */

Reply via email to