org.apache.logging.log4j

Class MarkerManager.Log4jMarker

java.lang.Object

org.apache.logging.log4j.MarkerManager.Log4jMarker

All Implemented Interfaces:

java.io.Serializable, Marker, StringBuilderFormattable

Enclosing class:

MarkerManager

public static class MarkerManager.Log4jMarker
extends java.lang.Object
implements Marker, 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:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	name
private Marker[]	parents
private static long	serialVersionUID

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Log4jMarker() Required by JAXB and Jackson for XML and JSON IO.
	Log4jMarker(java.lang.String name) Constructs a new Marker.

Method Summary

Modifier and Type	Method and Description
private static void	addParentInfo(java.lang.StringBuilder sb, Marker... parents)
Marker	addParents(Marker... parentMarkers) Adds a Marker as a parent to this Marker.
private static boolean	checkParent(Marker parent, Marker marker)
private static boolean	contains(Marker parent, Marker... localParents)
boolean	equals(java.lang.Object o) Returns true if the given marker has the same name as this marker.
void	formatTo(java.lang.StringBuilder sb) Writes a text representation of this object into the specified StringBuilder, ideally without allocating temporary objects.
java.lang.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(Marker marker) Checks whether this Marker is an instance of the specified Marker.
boolean	isInstanceOf(java.lang.String markerName) Checks whether this Marker is an instance of the specified Marker.
boolean	remove(Marker parent) Removes the specified Marker as a parent of this Marker.
Marker	setParents(Marker... markers) Replaces the set of parent Markers with the provided Markers.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

name

private final java.lang.String name

parents

private volatile Marker[] parents

Constructor Detail

Log4jMarker

private Log4jMarker()

Required by JAXB and Jackson for XML and JSON IO.

Log4jMarker

public Log4jMarker(java.lang.String name)

Constructs a new Marker.

Parameters:

name - the name of the Marker.

Throws:

java.lang.IllegalArgumentException - if the argument is null

Method Detail

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 java.lang.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(java.lang.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.

checkParent

private static boolean checkParent(Marker parent,
                                   Marker marker)

contains

private static boolean contains(Marker parent,
                                Marker... localParents)

equals

public boolean equals(java.lang.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 java.lang.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 java.lang.Object

Returns:

the computed hash code

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

formatTo

public void formatTo(java.lang.StringBuilder sb)

Description copied from interface: StringBuilderFormattable

Writes a text representation of this object into the specified StringBuilder, ideally without allocating temporary objects.

Specified by:

formatTo in interface StringBuilderFormattable

Parameters:

sb - the StringBuilder to write into

addParentInfo

private static void addParentInfo(java.lang.StringBuilder sb,
                                  Marker... parents)