Package org.slf4j.helpers

Class BasicMarkerFactory

  • All Implemented Interfaces:
    IMarkerFactory
    public class BasicMarkerFactory
extends java.lang.Object
implements IMarkerFactory
    An almost trivial implementation of the IMarkerFactory interface which creates BasicMarker instances.

    Simple logging systems can conform to the SLF4J API by binding MarkerFactory with an instance of this class.

    • Constructor Summary

      Constructors 
      Constructor Description
      BasicMarkerFactory()
      Regular users should not create BasicMarkerFactory instances.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean detachMarker​(java.lang.String name)
      Detach an existing marker.
      boolean exists​(java.lang.String name)
      Does the name marked already exist?
      Marker getDetachedMarker​(java.lang.String name)
      Create a marker which is detached (even at birth) from this IMarkerFactory.
      Marker getMarker​(java.lang.String name)
      Manufacture a BasicMarker instance by name.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • BasicMarkerFactory

        public BasicMarkerFactory()
        Regular users should not create BasicMarkerFactory instances. Marker instances can be obtained using the static MarkerFactory.getMarker(java.lang.String) method.

    • Method Detail

      • getMarker

        public Marker getMarker​(java.lang.String name)
        Manufacture a BasicMarker instance by name. If the instance has been created earlier, return the previously created instance.
        Specified by:
        getMarker in interface IMarkerFactory
        Parameters:
        name - the name of the marker to be created
        Returns:
        a Marker instance

      • exists

        public boolean exists​(java.lang.String name)
        Does the name marked already exist?
        Specified by:
        exists in interface IMarkerFactory
        Parameters:
        name - logger name to check for
        Returns:
        true id the marker exists, false otherwise.

      • detachMarker

        public boolean detachMarker​(java.lang.String name)
        Description copied from interface: IMarkerFactory
        Detach an existing marker.

        Note that after a marker is detached, there might still be "dangling" references to the detached marker.

        Specified by:
        detachMarker in interface IMarkerFactory
        Parameters:
        name - The name of the marker to detach
        Returns:
        whether the marker could be detached or not

      • getDetachedMarker

        public Marker getDetachedMarker​(java.lang.String name)
        Description copied from interface: IMarkerFactory
        Create a marker which is detached (even at birth) from this IMarkerFactory.
        Specified by:
        getDetachedMarker in interface IMarkerFactory
        Parameters:
        name - marker name
        Returns:
        a dangling marker