Checkstyle: FileTabCharacter, removed trailing space (IDE autoformatted), removed redundant 'public' keyword
Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/2898bcb2 Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/2898bcb2 Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/2898bcb2 Branch: refs/heads/master Commit: 2898bcb2c0a17b027a2ce360aadc79a6032e8d6f Parents: 78e9af5 Author: rpopma <[email protected]> Authored: Thu Sep 24 08:50:34 2015 +0200 Committer: rpopma <[email protected]> Committed: Thu Sep 24 08:50:34 2015 +0200 ---------------------------------------------------------------------- .../java/org/apache/logging/log4j/Marker.java | 40 ++++++++++++-------- 1 file changed, 24 insertions(+), 16 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2898bcb2/log4j-api/src/main/java/org/apache/logging/log4j/Marker.java ---------------------------------------------------------------------- diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/Marker.java b/log4j-api/src/main/java/org/apache/logging/log4j/Marker.java index 8bad2fc..784486e 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/Marker.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/Marker.java @@ -19,16 +19,17 @@ package org.apache.logging.log4j; import java.io.Serializable; /** - * Markers are objects that are used to add easily filterable information to log messages. + * Markers are objects that are used to add easily filterable information to log messages. * - * Markers can be hierarchical - each Marker may have a parent. This allows for broad categories - * being subdivided into more specific categories. An example might be a Marker named "Error" with - * children named "SystemError" and "ApplicationError". + * Markers can be hierarchical - each Marker may have a parent. This allows for broad categories being subdivided into + * more specific categories. An example might be a Marker named "Error" with children named "SystemError" and + * "ApplicationError". */ public interface Marker extends Serializable { - /** + /** * Adds a Marker as a parent to this Marker. + * * @param markers The parent markers to add. * @return The current Marker object, thus allowing multiple adds to be concatenated. * @throws IllegalArgumentException if the argument is {@code null} @@ -36,44 +37,48 @@ public interface Marker extends Serializable { Marker addParents(Marker... markers); /** - * Returns true if the given marker has the same name as this marker. - * - * @param obj the reference object with which to compare. - * @return true if the given marker has the same name as this marker. - * @since 2.4 - */ + * Returns true if the given marker has the same name as this marker. + * + * @param obj the reference object with which to compare. + * @return true if the given marker has the same name as this marker. + * @since 2.4 + */ @Override - public boolean equals(Object obj); + boolean equals(Object obj); /** * Returns the name of this Marker. + * * @return The name of the Marker. */ String getName(); /** * Returns a list of parents of this Marker. + * * @return The parent Markers or {@code null} if this Marker has no parents. */ Marker[] getParents(); /** - * Returns a hash code value based on the name of this marker. - * Markers are equal if they have the same name. + * Returns a hash code value based on the name of this marker. Markers are equal if they have the same name. + * * @return the computed hash code - * @since 2.4 + * @since 2.4 */ @Override - public int hashCode(); + int hashCode(); /** * Indicates whether this Marker has references to any other Markers. + * * @return {@code true} if the Marker has parent Markers */ boolean hasParents(); /** * Checks whether this Marker is an instance of the specified Marker. + * * @param m The Marker to check. * @return {@code true} if this Marker or one of its ancestors is the specified Marker, {@code false} otherwise. * @throws IllegalArgumentException if the argument is {@code null} @@ -82,6 +87,7 @@ public interface Marker extends Serializable { /** * Checks whether this Marker is an instance of the specified Marker. + * * @param name The name of the Marker. * @return {@code true} if this Marker or one of its ancestors matches the specified name, {@code false} otherwise. * @throws IllegalArgumentException if the argument is {@code null} @@ -90,6 +96,7 @@ public interface Marker extends Serializable { /** * Removes the specified Marker as a parent of this Marker. + * * @param marker The marker to remove. * @return {@code true} if the marker was removed. * @throws IllegalArgumentException if the argument is {@code null} @@ -98,6 +105,7 @@ public interface Marker extends Serializable { /** * Replaces the set of parent Markers with the provided Markers. + * * @param markers The new set of parent Markers or {@code null} to clear the parents. * @return The current Marker object. */
