Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## 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
`Marker` | `addParents(Marker... markers)` Adds a Marker as a parent to this Marker.
`String` | `getName()` Returns the name of this Marker.
`Marker[]` | `getParents()` Returns a list of parents of this Marker.
`boolean` | `hasParents()` Indicates whether this Marker has references to any other Markers.
`boolean` | `isInstanceOf(Marker m)` Checks whether this Marker is an instance of the specified Marker.
`boolean` | `isInstanceOf(String name)` 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 Detail

### 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.

### 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`

### 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`

### 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.

### 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`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 1999-2015 Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.