Repository: logging-log4j2 Updated Branches: refs/heads/master 8e01bde35 -> 7d8ea7abd
Javadoc: Use the active voice. Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/7d8ea7ab Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/7d8ea7ab Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/7d8ea7ab Branch: refs/heads/master Commit: 7d8ea7abd11d4823f4b8955084ecc0ddbc625856 Parents: 8e01bde Author: Gary Gregory <[email protected]> Authored: Sun Aug 14 18:57:11 2016 -0700 Committer: Gary Gregory <[email protected]> Committed: Sun Aug 14 18:57:11 2016 -0700 ---------------------------------------------------------------------- .../apache/logging/log4j/spi/ThreadContextMap.java | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/7d8ea7ab/log4j-api/src/main/java/org/apache/logging/log4j/spi/ThreadContextMap.java ---------------------------------------------------------------------- diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/spi/ThreadContextMap.java b/log4j-api/src/main/java/org/apache/logging/log4j/spi/ThreadContextMap.java index dcf5942..3235487 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/spi/ThreadContextMap.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/spi/ThreadContextMap.java @@ -22,8 +22,9 @@ import java.util.Map; * Service provider interface to implement custom MDC behavior for {@link org.apache.logging.log4j.ThreadContext}. */ public interface ThreadContextMap { + /** - * Put a context value (the <code>o</code> parameter) as identified + * Puts a context value (the <code>o</code> parameter) as identified * with the <code>key</code> parameter into the current thread's * context map. * @@ -35,7 +36,7 @@ public interface ThreadContextMap { void put(final String key, final String value); /** - * Get the context identified by the <code>key</code> parameter. + * Gets the context identified by the <code>key</code> parameter. * * <p>This method has no side effects.</p> * @param key The key to locate. @@ -44,32 +45,32 @@ public interface ThreadContextMap { String get(final String key); /** - * Remove the the context identified by the <code>key</code> + * Removes the the context identified by the <code>key</code> * parameter. * @param key The key to remove. */ void remove(final String key); /** - * Clear the context. + * Clears the context. */ void clear(); /** - * Determine if the key is in the context. + * Determines if the key is in the context. * @param key The key to locate. * @return True if the key is in the context, false otherwise. */ boolean containsKey(final String key); /** - * Get a non-{@code null} mutable copy of current thread's context Map. + * Gets a non-{@code null} mutable copy of current thread's context Map. * @return a mutable copy of the context. */ Map<String, String> getCopy(); /** - * Return an immutable view on the context Map or {@code null} if the context map is empty. + * Returns an immutable view on the context Map or {@code null} if the context map is empty. * @return an immutable context Map or {@code null}. */ Map<String, String> getImmutableMapOrNull();
