net.logstash.logback.marker

Class SingleFieldAppendingMarker

java.lang.Object

org.slf4j.helpers.BasicMarker

org.slf4j.helpers.LogstashBasicMarker

net.logstash.logback.marker.LogstashMarker

net.logstash.logback.marker.SingleFieldAppendingMarker

All Implemented Interfaces:

java.io.Serializable, org.slf4j.Marker

Direct Known Subclasses:

ObjectAppendingMarker, RawJsonAppendingMarker

public abstract class SingleFieldAppendingMarker
extends LogstashMarker

A marker that appends a single field into the logstash json event.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MARKER_NAME_PREFIX

Fields inherited from interface org.slf4j.Marker

ANY_MARKER, ANY_NON_NULL_MARKER

Constructor Summary

Constructors

Constructor and Description
SingleFieldAppendingMarker(java.lang.String markerName, java.lang.String fieldName)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getFieldName()
int	hashCode()
protected void	writeFieldName(com.fasterxml.jackson.core.JsonGenerator generator) Writes the field name to the generator.
protected abstract void	writeFieldValue(com.fasterxml.jackson.core.JsonGenerator generator, com.fasterxml.jackson.databind.ObjectMapper mapper) Writes the field value to the generator.
void	writeTo(com.fasterxml.jackson.core.JsonGenerator generator, com.fasterxml.jackson.databind.ObjectMapper mapper) Writes the data associated with this marker to the given JsonGenerator.

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

with

Methods inherited from class org.slf4j.helpers.BasicMarker

add, contains, contains, getName, hasChildren, hasReferences, iterator, remove, toString

Methods inherited from class java.lang.Object

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

Field Detail

MARKER_NAME_PREFIX

public static final java.lang.String MARKER_NAME_PREFIX

See Also:

Constant Field Values

Constructor Detail

SingleFieldAppendingMarker

public SingleFieldAppendingMarker(java.lang.String markerName,
                          java.lang.String fieldName)

Method Detail

getFieldName

public java.lang.String getFieldName()

writeTo

public void writeTo(com.fasterxml.jackson.core.JsonGenerator generator,
           com.fasterxml.jackson.databind.ObjectMapper mapper)
             throws java.io.IOException

Description copied from class: LogstashMarker

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

The ObjectMapper can be used to write objects if necessary. In particular ObjectMapper.writeValue(JsonGenerator, Object), ObjectMapper.writeTree(JsonGenerator, com.fasterxml.jackson.databind.JsonNode), and ObjectMapper.writeTree(JsonGenerator, com.fasterxml.jackson.core.TreeNode) can be useful.

Specified by:

writeTo in class LogstashMarker

Throws:

java.io.IOException

writeFieldName

protected void writeFieldName(com.fasterxml.jackson.core.JsonGenerator generator)
                       throws java.io.IOException

Writes the field name to the generator.

Throws:

java.io.IOException

writeFieldValue

protected abstract void writeFieldValue(com.fasterxml.jackson.core.JsonGenerator generator,
                   com.fasterxml.jackson.databind.ObjectMapper mapper)
                                 throws java.io.IOException

Writes the field value to the generator.

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface org.slf4j.Marker

Overrides:

equals in class org.slf4j.helpers.BasicMarker

hashCode

public int hashCode()

Specified by:

hashCode in interface org.slf4j.Marker

Overrides:

hashCode in class org.slf4j.helpers.BasicMarker