Package org.apache.logging.log4j

Class MarkerManager.Log4jMarker

java.lang.Object
org.apache.logging.log4j.MarkerManager.Log4jMarker
All Implemented Interfaces:
Serializable, Marker, org.apache.logging.log4j.util.StringBuilderFormattable
Enclosing class:
MarkerManager
public static class MarkerManager.Log4jMarker extends Object implements Marker, org.apache.logging.log4j.util.StringBuilderFormattable
Consider this class private, it is only public to satisfy Jackson for XML and JSON IO.

The actual Marker implementation.

Internal note: We could make this class package private instead of public if the class org.apache.logging.log4j.core.jackson.MarkerMixIn is moved to this package and would of course stay in its current module.

See Also:

  • Constructor Details

    • Log4jMarker

      public Log4jMarker(String name)
      Constructs a new Marker.
      Parameters:
      name - the name of the Marker.
      Throws:
      IllegalArgumentException - if the argument is null

  • Method Details

    • addParents

      public Marker addParents(Marker... parentMarkers)
      Description copied from interface: Marker
      Adds a Marker as a parent to this Marker.
      Specified by:
      addParents in interface Marker
      Parameters:
      parentMarkers - The parent markers to add.
      Returns:
      The current Marker object, thus allowing multiple adds to be concatenated.

    • remove

      public boolean remove(Marker parent)
      Description copied from interface: Marker
      Removes the specified Marker as a parent of this Marker.
      Specified by:
      remove in interface Marker
      Parameters:
      parent - The marker to remove.
      Returns:
      true if the marker was removed.

    • setParents

      public Marker setParents(Marker... markers)
      Description copied from interface: Marker
      Replaces the set of parent Markers with the provided Markers.
      Specified by:
      setParents in interface Marker
      Parameters:
      markers - The new set of parent Markers or null to clear the parents.
      Returns:
      The current Marker object.

    • getName

      public String getName()
      Description copied from interface: Marker
      Returns the name of this Marker.
      Specified by:
      getName in interface Marker
      Returns:
      The name of the Marker.

    • getParents

      public Marker[] getParents()
      Description copied from interface: Marker
      Returns a list of parents of this Marker.
      Specified by:
      getParents in interface Marker
      Returns:
      The parent Markers or null if this Marker has no parents.

    • hasParents

      public boolean hasParents()
      Description copied from interface: Marker
      Indicates whether this Marker has references to any other Markers.
      Specified by:
      hasParents in interface Marker
      Returns:
      true if the Marker has parent Markers

    • isInstanceOf

      public boolean isInstanceOf(Marker marker)
      Description copied from interface: Marker
      Checks whether this Marker is an instance of the specified Marker.
      Specified by:
      isInstanceOf in interface Marker
      Parameters:
      marker - The Marker to check.
      Returns:
      true if this Marker or one of its ancestors is the specified Marker, false otherwise.

    • isInstanceOf

      public boolean isInstanceOf(String markerName)
      Description copied from interface: Marker
      Checks whether this Marker is an instance of the specified Marker.
      Specified by:
      isInstanceOf in interface Marker
      Parameters:
      markerName - The name of the Marker.
      Returns:
      true if this Marker or one of its ancestors matches the specified name, false otherwise.

    • equals

      public boolean equals(Object o)
      Description copied from interface: Marker
      Returns true if the given marker has the same name as this marker.
      Specified by:
      equals in interface Marker
      Overrides:
      equals in class Object
      Parameters:
      o - the reference object with which to compare.
      Returns:
      true if the given marker has the same name as this marker.

    • hashCode

      public int hashCode()
      Description copied from interface: Marker
      Returns a hash code value based on the name of this marker. Markers are equal if they have the same name.
      Specified by:
      hashCode in interface Marker
      Overrides:
      hashCode in class Object
      Returns:
      the computed hash code

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • formatTo

      public void formatTo(StringBuilder sb)
      Specified by:
      formatTo in interface org.apache.logging.log4j.util.StringBuilderFormattable