net.logstash.logback.marker

Class DeferredLogstashMarker

java.lang.Object

net.logstash.logback.marker.LogstashMarker

net.logstash.logback.marker.DeferredLogstashMarker

All Implemented Interfaces:

Serializable, Iterable<org.slf4j.Marker>, org.slf4j.Marker

public class DeferredLogstashMarker
extends LogstashMarker

A LogstashMarker that defers the creation of another LogstashMarker until the first time it is encoded.

Encoding (and therefore the deferred marker creation) can potentially take place on another thread if an async appender (e.g. AsyncAppender or AsyncDisruptorAppender) is used.

The deferred value will only be calculated once. The single value supplied by the supplier will be reused every time the marker is written. For example, if multiple appenders use a logstash encoder, the supplier will be invoked when the first appender encodes the marker. That same supplied value will be used when the next appender encodes the marker.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFERRED_MARKER_NAME

Fields inherited from class net.logstash.logback.marker.LogstashMarker

MARKER_NAME_PREFIX

Fields inherited from interface org.slf4j.Marker

ANY_MARKER, ANY_NON_NULL_MARKER

Constructor Summary

Constructors

Constructor and Description
DeferredLogstashMarker(Supplier<? extends LogstashMarker> logstashMarkerSupplier)

Method Summary

Modifier and Type	Method and Description
boolean	contains(org.slf4j.Marker other)
boolean	contains(String name)
boolean	equals(Object obj)
String	getName()
boolean	hasChildren() Deprecated.
int	hashCode()
boolean	hasReferences()
Iterator<org.slf4j.Marker>	iterator()
boolean	remove(org.slf4j.Marker referenceToRemove)
void	writeTo(JsonGenerator generator) Writes the data associated with this marker to the given JsonGenerator.

Methods inherited from class net.logstash.logback.marker.LogstashMarker

add, and, toString, toStringSelf, with

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Field Detail

DEFERRED_MARKER_NAME

public static final String DEFERRED_MARKER_NAME

See Also:

Constant Field Values

Constructor Detail

DeferredLogstashMarker

public DeferredLogstashMarker(Supplier<? extends LogstashMarker> logstashMarkerSupplier)

Method Detail

writeTo

public void writeTo(JsonGenerator generator)
             throws IOException

Description copied from class: LogstashMarker

Writes the data associated with this marker to the given JsonGenerator.

Specified by:

writeTo in class LogstashMarker

Parameters:

generator - the generator to which to write the output of this marker.

Throws:

IOException - if there was an error writing to the generator

equals

public boolean equals(Object obj)

Specified by:

equals in interface org.slf4j.Marker

hashCode

public int hashCode()

Specified by:

hashCode in interface org.slf4j.Marker

getName

public String getName()

Specified by:

getName in interface org.slf4j.Marker

hasReferences

public boolean hasReferences()

Specified by:

hasReferences in interface org.slf4j.Marker

hasChildren

@Deprecated
public boolean hasChildren()

Deprecated.

Specified by:

hasChildren in interface org.slf4j.Marker

iterator

public Iterator<org.slf4j.Marker> iterator()

Specified by:

iterator in interface org.slf4j.Marker

remove

public boolean remove(org.slf4j.Marker referenceToRemove)

Specified by:

remove in interface org.slf4j.Marker

contains

public boolean contains(org.slf4j.Marker other)

Specified by:

contains in interface org.slf4j.Marker

contains

public boolean contains(String name)

Specified by:

contains in interface org.slf4j.Marker