You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by rp...@apache.org on 2016/09/12 14:37:11 UTC
logging-log4j2 git commit: LOG4J2-1447 renamed ContextData::asMap to
::toMap, since it returns a copy,
not a view. Clarified in javadoc that returned Map is mutable.
Repository: logging-log4j2
Updated Branches:
refs/heads/master 0fac914f9 -> c78e50691
LOG4J2-1447 renamed ContextData::asMap to ::toMap, since it returns a copy, not a view. Clarified in javadoc that returned Map is mutable.
Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo
Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/c78e5069
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/c78e5069
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/c78e5069
Branch: refs/heads/master
Commit: c78e506913b8b7cc0529f465ee3a3420c764146d
Parents: 0fac914
Author: rpopma <rp...@apache.org>
Authored: Mon Sep 12 23:37:12 2016 +0900
Committer: rpopma <rp...@apache.org>
Committed: Mon Sep 12 23:37:12 2016 +0900
----------------------------------------------------------------------
.../apache/logging/log4j/spi/ContextData.java | 6 +++---
.../CopyOnWriteSortedArrayThreadContextMap.java | 4 ++--
.../log4j/spi/DefaultThreadContextMap.java | 2 +-
.../GarbageFreeSortedArrayThreadContextMap.java | 4 ++--
.../logging/log4j/util/ArrayContextData.java | 2 +-
.../log4j/util/ArrayContextDataTest.java | 21 ++++++++++----------
.../log4j/core/async/RingBufferLogEvent.java | 2 +-
.../logging/log4j/core/impl/Log4jLogEvent.java | 2 +-
.../log4j/core/impl/MutableLogEvent.java | 2 +-
.../log4j/perf/nogc/OpenHashMapContextData.java | 6 +++---
10 files changed, 25 insertions(+), 26 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/c78e5069/log4j-api/src/main/java/org/apache/logging/log4j/spi/ContextData.java
----------------------------------------------------------------------
diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/spi/ContextData.java b/log4j-api/src/main/java/org/apache/logging/log4j/spi/ContextData.java
index d62b3f4..787b1da 100644
--- a/log4j-api/src/main/java/org/apache/logging/log4j/spi/ContextData.java
+++ b/log4j-api/src/main/java/org/apache/logging/log4j/spi/ContextData.java
@@ -35,11 +35,11 @@ import org.apache.logging.log4j.util.TriConsumer;
*/
public interface ContextData extends Serializable {
/**
- * Returns a {@code Map<String, String>} view of this context data.
+ * Returns a non-{@code null} mutable {@code Map<String, String>} containing a snapshot of this context data.
*
- * @return a map view of this context data
+ * @return a mutable copy of this context data in {@code Map<String, String>} form
*/
- Map<String, String> asMap();
+ Map<String, String> toMap();
/**
* Returns {@code true} if this context data contains the specified key, {@code false} otherwise.
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/c78e5069/log4j-api/src/main/java/org/apache/logging/log4j/spi/CopyOnWriteSortedArrayThreadContextMap.java
----------------------------------------------------------------------
diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/spi/CopyOnWriteSortedArrayThreadContextMap.java b/log4j-api/src/main/java/org/apache/logging/log4j/spi/CopyOnWriteSortedArrayThreadContextMap.java
index 57348dd..a8ced14 100644
--- a/log4j-api/src/main/java/org/apache/logging/log4j/spi/CopyOnWriteSortedArrayThreadContextMap.java
+++ b/log4j-api/src/main/java/org/apache/logging/log4j/spi/CopyOnWriteSortedArrayThreadContextMap.java
@@ -153,7 +153,7 @@ class CopyOnWriteSortedArrayThreadContextMap implements ThreadContextMap, Thread
@Override
public Map<String, String> getCopy() {
final MutableContextData map = localMap.get();
- return map == null ? new HashMap<String, String>() : map.asMap();
+ return map == null ? new HashMap<String, String>() : map.toMap();
}
/**
@@ -168,7 +168,7 @@ class CopyOnWriteSortedArrayThreadContextMap implements ThreadContextMap, Thread
@Override
public Map<String, String> getImmutableMapOrNull() {
final MutableContextData map = localMap.get();
- return map == null ? null : Collections.unmodifiableMap(map.asMap());
+ return map == null ? null : Collections.unmodifiableMap(map.toMap());
}
@Override
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/c78e5069/log4j-api/src/main/java/org/apache/logging/log4j/spi/DefaultThreadContextMap.java
----------------------------------------------------------------------
diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/spi/DefaultThreadContextMap.java b/log4j-api/src/main/java/org/apache/logging/log4j/spi/DefaultThreadContextMap.java
index a6b4071..c326389 100644
--- a/log4j-api/src/main/java/org/apache/logging/log4j/spi/DefaultThreadContextMap.java
+++ b/log4j-api/src/main/java/org/apache/logging/log4j/spi/DefaultThreadContextMap.java
@@ -115,7 +115,7 @@ public class DefaultThreadContextMap implements ThreadContextMap2, ContextData {
}
@Override
- public Map<String, String> asMap() {
+ public Map<String, String> toMap() {
return getCopy();
}
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/c78e5069/log4j-api/src/main/java/org/apache/logging/log4j/spi/GarbageFreeSortedArrayThreadContextMap.java
----------------------------------------------------------------------
diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/spi/GarbageFreeSortedArrayThreadContextMap.java b/log4j-api/src/main/java/org/apache/logging/log4j/spi/GarbageFreeSortedArrayThreadContextMap.java
index cf93367..067d5f0 100644
--- a/log4j-api/src/main/java/org/apache/logging/log4j/spi/GarbageFreeSortedArrayThreadContextMap.java
+++ b/log4j-api/src/main/java/org/apache/logging/log4j/spi/GarbageFreeSortedArrayThreadContextMap.java
@@ -155,7 +155,7 @@ class GarbageFreeSortedArrayThreadContextMap implements ThreadContextMap, Thread
@Override
public Map<String, String> getCopy() {
final MutableContextData map = localMap.get();
- return map == null ? new HashMap<String, String>() : map.asMap();
+ return map == null ? new HashMap<String, String>() : map.toMap();
}
/**
@@ -174,7 +174,7 @@ class GarbageFreeSortedArrayThreadContextMap implements ThreadContextMap, Thread
@Override
public Map<String, String> getImmutableMapOrNull() {
final MutableContextData map = localMap.get();
- return map == null ? null : Collections.unmodifiableMap(map.asMap());
+ return map == null ? null : Collections.unmodifiableMap(map.toMap());
}
@Override
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/c78e5069/log4j-api/src/main/java/org/apache/logging/log4j/util/ArrayContextData.java
----------------------------------------------------------------------
diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/util/ArrayContextData.java b/log4j-api/src/main/java/org/apache/logging/log4j/util/ArrayContextData.java
index fd9e9bb..a3cb0aa 100644
--- a/log4j-api/src/main/java/org/apache/logging/log4j/util/ArrayContextData.java
+++ b/log4j-api/src/main/java/org/apache/logging/log4j/util/ArrayContextData.java
@@ -140,7 +140,7 @@ public class ArrayContextData implements MutableContextData {
}
@Override
- public Map<String, String> asMap() {
+ public Map<String, String> toMap() {
final Map<String, String> result = new HashMap<>(size());
for (int i = 0; i < size(); i++) {
final Object value = getValueAt(i);
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/c78e5069/log4j-api/src/test/java/org/apache/logging/log4j/util/ArrayContextDataTest.java
----------------------------------------------------------------------
diff --git a/log4j-api/src/test/java/org/apache/logging/log4j/util/ArrayContextDataTest.java b/log4j-api/src/test/java/org/apache/logging/log4j/util/ArrayContextDataTest.java
index 274972e..db9cfc2 100644
--- a/log4j-api/src/test/java/org/apache/logging/log4j/util/ArrayContextDataTest.java
+++ b/log4j-api/src/test/java/org/apache/logging/log4j/util/ArrayContextDataTest.java
@@ -134,7 +134,7 @@ public class ArrayContextDataTest {
}
@Test
- public void testAsMap() throws Exception {
+ public void testToMap() throws Exception {
final ArrayContextData original = new ArrayContextData();
original.putValue("a", "avalue");
original.putValue("B", "Bvalue");
@@ -145,13 +145,12 @@ public class ArrayContextDataTest {
expected.put("B", "Bvalue");
expected.put("3", "3value");
- assertEquals(expected, original.asMap());
+ assertEquals(expected, original.toMap());
try {
- original.asMap().put("abc", "xyz");
- fail("Expected map to be immutable");
- } catch (final UnsupportedOperationException ok) {
- //ok
+ original.toMap().put("abc", "xyz");
+ } catch (final UnsupportedOperationException ex) {
+ fail("Expected map to be mutable, but " + ex);
}
}
@@ -449,27 +448,27 @@ public class ArrayContextDataTest {
expected.put("3", "3value");
expected.put("c", "cvalue");
expected.put("d", "dvalue");
- assertEquals("initial", expected, original.asMap());
+ assertEquals("initial", expected, original.toMap());
original.putValue(null, "nullvalue");
expected.put(null, "nullvalue");
assertEquals(6, original.size());
- assertEquals("with null key", expected, original.asMap());
+ assertEquals("with null key", expected, original.toMap());
original.putValue(null, "otherNullvalue");
expected.put(null, "otherNullvalue");
assertEquals(6, original.size());
- assertEquals("with null key value2", expected, original.asMap());
+ assertEquals("with null key value2", expected, original.toMap());
original.putValue(null, "nullvalue");
expected.put(null, "nullvalue");
assertEquals(6, original.size());
- assertEquals("with null key value1 again", expected, original.asMap());
+ assertEquals("with null key value1 again", expected, original.toMap());
original.putValue(null, "abc");
expected.put(null, "abc");
assertEquals(6, original.size());
- assertEquals("with null key value3", expected, original.asMap());
+ assertEquals("with null key value3", expected, original.toMap());
}
@Test
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/c78e5069/log4j-core/src/main/java/org/apache/logging/log4j/core/async/RingBufferLogEvent.java
----------------------------------------------------------------------
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/async/RingBufferLogEvent.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/async/RingBufferLogEvent.java
index 5a60483..fd273b3 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/async/RingBufferLogEvent.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/async/RingBufferLogEvent.java
@@ -335,7 +335,7 @@ public class RingBufferLogEvent implements LogEvent, ReusableMessage, CharSequen
@SuppressWarnings("unchecked")
@Override
public Map<String, String> getContextMap() {
- return contextData.asMap();
+ return contextData.toMap();
}
@Override
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/c78e5069/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/Log4jLogEvent.java
----------------------------------------------------------------------
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/Log4jLogEvent.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/Log4jLogEvent.java
index 19b7afd..f8af061 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/Log4jLogEvent.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/Log4jLogEvent.java
@@ -591,7 +591,7 @@ public class Log4jLogEvent implements LogEvent {
*/
@Override
public Map<String, String> getContextMap() {
- return contextData.asMap();
+ return contextData.toMap();
}
/**
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/c78e5069/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/MutableLogEvent.java
----------------------------------------------------------------------
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/MutableLogEvent.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/MutableLogEvent.java
index 2a4f59b..f0a20c9 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/MutableLogEvent.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/MutableLogEvent.java
@@ -355,7 +355,7 @@ public class MutableLogEvent implements LogEvent, ReusableMessage {
@Override
public Map<String, String> getContextMap() {
- return contextData.asMap();
+ return contextData.toMap();
}
public void setContextData(final MutableContextData mutableContextData) {
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/c78e5069/log4j-perf/src/main/java/org/apache/logging/log4j/perf/nogc/OpenHashMapContextData.java
----------------------------------------------------------------------
diff --git a/log4j-perf/src/main/java/org/apache/logging/log4j/perf/nogc/OpenHashMapContextData.java b/log4j-perf/src/main/java/org/apache/logging/log4j/perf/nogc/OpenHashMapContextData.java
index a7357b8..0074c59 100644
--- a/log4j-perf/src/main/java/org/apache/logging/log4j/perf/nogc/OpenHashMapContextData.java
+++ b/log4j-perf/src/main/java/org/apache/logging/log4j/perf/nogc/OpenHashMapContextData.java
@@ -240,7 +240,7 @@ public class OpenHashMapContextData<K, V> implements MutableContextData, ThreadC
}
@Override
- public Map<String, String> asMap() {
+ public Map<String, String> toMap() {
final Map<String, String> result = new HashMap<>(size);
forEach(COPY_INTO_MAP, result);
return result;
@@ -426,12 +426,12 @@ public class OpenHashMapContextData<K, V> implements MutableContextData, ThreadC
@Override
public Map<String, String> getCopy() {
- return asMap();
+ return toMap();
}
@Override
public Map<String, String> getImmutableMapOrNull() {
- return isEmpty() ? null : Collections.unmodifiableMap(asMap());
+ return isEmpty() ? null : Collections.unmodifiableMap(toMap());
}
@Override