BasicMarker

java.lang.Object
- org.slf4j.helpers.BasicMarker

All Implemented Interfaces:

Serializable, Marker
```
public class BasicMarker
extends Object
implements Marker
```
A simple implementation of the Marker interface.

Author:

Ceki Gülcü, Joern Huxhorn

See Also:

Serialized Form

Field Summary
- Fields inherited from interface org.slf4j.Marker
  ANY_MARKER, ANY_NON_NULL_MARKER

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Marker reference)` Add a reference to another Marker.
`boolean`	`contains(Marker other)` Does this marker contain a reference to the 'other' marker? Marker A is defined to contain marker B, if A == B or if B is referenced by A, or if B is referenced by any one of A's references (recursively).
`boolean`	`contains(String name)` This method is mainly used with Expression Evaluators.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`String`	`getName()` Get the name of this Marker.
`boolean`	`hasChildren()`
`int`	`hashCode()` Returns a hash code value for the object.
`boolean`	`hasReferences()` Does this marker have any references?
`Iterator<Marker>`	`iterator()` Returns an Iterator which can be used to iterate over the references of this marker.
`boolean`	`remove(Marker referenceToRemove)` Remove a marker reference.
`String`	`toString()` Returns a string representation of the object.

Methods inherited from class java.lang.Object
clone, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - add
```
public void add(Marker reference)
```
    Description copied from interface: Marker
    
    Add a reference to another Marker.
    
    Specified by:
    
    add in interface Marker
    
    Parameters:
    
    reference - a reference to another marker
  - contains
```
public boolean contains(Marker other)
```
    Description copied from interface: Marker
    
    Does this marker contain a reference to the 'other' marker? Marker A is defined to contain marker B, if A == B or if B is referenced by A, or if B is referenced by any one of A's references (recursively).
    
    Specified by:
    
    contains in interface Marker
    
    Parameters:
    
    other - The marker to test for inclusion.
    
    Returns:
    
    Whether this marker contains the other marker.
  - contains
```
public boolean contains(String name)
```
    This method is mainly used with Expression Evaluators.
    
    Specified by:
    
    contains in interface Marker
    
    Parameters:
    
    name - The marker name to test for inclusion.
    
    Returns:
    
    Whether this marker contains the other marker.
  - equals
```
public boolean equals(Object obj)
```
    Description copied from class: Object
    Indicates whether some other object is "equal to" this one.
    The equals method implements an equivalence relation on non-null object references:
    - It is reflexive: for any non-null reference value x, x.equals(x) should return true.
    - It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
    - It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
    - It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
    - For any non-null reference value x, x.equals(null) should return false.
    The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).
    Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.
    Specified by:
    
    equals in interface Marker
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - the reference object with which to compare.
    
    Returns:
    
    true if this object is the same as the obj argument; false otherwise.
    
    See Also:
    
    Object.hashCode(), HashMap
  - getName
```
public String getName()
```
    Description copied from interface: Marker
    
    Get the name of this Marker.
    
    Specified by:
    
    getName in interface Marker
    
    Returns:
    
    name of marker
  - hasChildren
```
public boolean hasChildren()
```
    Specified by:
    
    hasChildren in interface Marker
  - hashCode
```
public int hashCode()
```
    Description copied from class: Object
    Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.
    The general contract of hashCode is:
    - Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
    - If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
    - It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
    As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java^TM programming language.)
    Specified by:
    
    hashCode in interface Marker
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    a hash code value for this object.
    
    See Also:
    
    Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)
  - hasReferences
```
public boolean hasReferences()
```
    Description copied from interface: Marker
    
    Does this marker have any references?
    
    Specified by:
    
    hasReferences in interface Marker
    
    Returns:
    
    true if this marker has one or more references, false otherwise.
  - iterator
```
public Iterator<Marker> iterator()
```
    Description copied from interface: Marker
    
    Returns an Iterator which can be used to iterate over the references of this marker. An empty iterator is returned when this marker has no references.
    
    Specified by:
    
    iterator in interface Marker
    
    Returns:
    
    Iterator over the references of this marker
  - remove
```
public boolean remove(Marker referenceToRemove)
```
    Description copied from interface: Marker
    
    Remove a marker reference.
    
    Specified by:
    
    remove in interface Marker
    
    Parameters:
    
    referenceToRemove - the marker reference to remove
    
    Returns:
    
    true if reference could be found and removed, false otherwise.
  - toString
```
public String toString()
```
    Description copied from class: Object
    Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.
    The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:
    getClass().getName() + '@' + Integer.toHexString(hashCode())
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the object.

Class BasicMarker

Field Summary

Fields inherited from interface org.slf4j.Marker

Method Summary

Methods inherited from class java.lang.Object

Method Detail

add

contains

contains

equals

getName

hasChildren

hashCode

hasReferences

iterator

remove

toString