Package org.apache.logging.log4j

Interface Marker

All Superinterfaces:
Serializable
All Known Implementing Classes:
MarkerManager.Log4jMarker
public interface Marker extends Serializable
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".

  • Method Summary

    Modifier and Type
    Method
    Description
    Marker
    addParents(Marker... markers)
    Adds a Marker as a parent to this Marker.
    boolean
    equals(Object obj)
    Returns true if the given marker has the same name as this marker.
    String
    getName()
    Returns the name of this Marker.
    Marker[]
    getParents()
    Returns a list of parents of this Marker.
    int
    hashCode()
    Returns a hash code value based on the name of this marker.
    boolean
    hasParents()
    Indicates whether this Marker has references to any other Markers.
    boolean
    isInstanceOf(String name)
    Checks whether this Marker is an instance of the specified Marker.
    boolean
    isInstanceOf(Marker m)
    Checks whether this Marker is an instance of the specified Marker.
    boolean
    remove(Marker marker)
    Removes the specified Marker as a parent of this Marker.
    Marker
    setParents(Marker... markers)
    Replaces the set of parent Markers with the provided Markers.

  • Method Details

    • addParents

      Marker addParents(Marker... markers)
      Adds a Marker as a parent to this Marker.
      Parameters:
      markers - The parent markers to add.
      Returns:
      The current Marker object, thus allowing multiple adds to be concatenated.
      Throws:
      IllegalArgumentException - if the argument is null

    • equals

      boolean equals(Object obj)
      Returns true if the given marker has the same name as this marker.
      Overrides:
      equals in class Object
      Parameters:
      obj - the reference object with which to compare.
      Returns:
      true if the given marker has the same name as this marker.
      Since:
      2.4

    • getName

      String getName()
      Returns the name of this Marker.
      Returns:
      The name of the Marker.

    • getParents

      Marker[] getParents()
      Returns a list of parents of this Marker.
      Returns:
      The parent Markers or null if this Marker has no parents.

    • hashCode

      int hashCode()
      Returns a hash code value based on the name of this marker. Markers are equal if they have the same name.
      Overrides:
      hashCode in class Object
      Returns:
      the computed hash code
      Since:
      2.4

    • hasParents

      boolean hasParents()
      Indicates whether this Marker has references to any other Markers.
      Returns:
      true if the Marker has parent Markers

    • isInstanceOf

      boolean isInstanceOf(Marker m)
      Checks whether this Marker is an instance of the specified Marker.
      Parameters:
      m - The Marker to check.
      Returns:
      true if this Marker or one of its ancestors is the specified Marker, false otherwise.
      Throws:
      IllegalArgumentException - if the argument is null

    • isInstanceOf

      boolean isInstanceOf(String name)
      Checks whether this Marker is an instance of the specified Marker.
      Parameters:
      name - The name of the Marker.
      Returns:
      true if this Marker or one of its ancestors matches the specified name, false otherwise.
      Throws:
      IllegalArgumentException - if the argument is null

    • remove

      boolean remove(Marker marker)
      Removes the specified Marker as a parent of this Marker.
      Parameters:
      marker - The marker to remove.
      Returns:
      true if the marker was removed.
      Throws:
      IllegalArgumentException - if the argument is null

    • setParents

      Marker setParents(Marker... markers)
      Replaces the set of parent Markers with the provided Markers.
      Parameters:
      markers - The new set of parent Markers or null to clear the parents.
      Returns:
      The current Marker object.