net.logstash.logback.marker

Class EmptyLogstashMarker

java.lang.Object

net.logstash.logback.marker.LogstashMarker

net.logstash.logback.marker.EmptyLogstashMarker

All Implemented Interfaces:

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

public class EmptyLogstashMarker
extends LogstashMarker
implements StructuredArgument

An empty marker that does nothing itself, but can be used as a base marker when you want to conditionally chain other markers with LogstashMarker.and(Marker). For example:

     LogstashMarker marker = Markers.empty();
     if (condition1) {
         marker = marker.and(Markers.append("fieldName1", value1);
     }
     if (condition2) {
         marker = marker.and(Markers.append("fieldName2", value2);
     }
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	EMPTY_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
EmptyLogstashMarker()

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)
protected String	toStringSelf() Returns a string representation of this object, without including any references.
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, with

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.logstash.logback.argument.StructuredArgument

toString

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Field Detail

EMPTY_MARKER_NAME

public static final String EMPTY_MARKER_NAME

See Also:

Constant Field Values

Constructor Detail

EmptyLogstashMarker

public EmptyLogstashMarker()

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 interface StructuredArgument

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

toStringSelf

protected String toStringSelf()

Description copied from class: LogstashMarker

Returns a string representation of this object, without including any references.

Subclasses should override LogstashMarker.toStringSelf() instead of LogstashMarker.toString(), since LogstashMarker.toString() will automatically include the LogstashMarker.toStringSelf() and references.

Overrides:

toStringSelf in class LogstashMarker

Returns:

a string representation of this object, without including any references.

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