Class LogEncoder.AbstractEncoder<T extends LogEncoder.Buffer>

java.lang.Object

io.jstach.rainbowgum.LogEncoder.AbstractEncoder<T>

Type Parameters:

T - buffer type.

All Implemented Interfaces:

LogEncoder

Direct Known Subclasses:

EcsEncoder, GelfEncoder, LogbackJsonEncoder, LogstashEncoder

Enclosing interface:

LogEncoder

public abstract static class LogEncoder.AbstractEncoder<T extends LogEncoder.Buffer>
extends Object
implements LogEncoder

Abstract encoder that will cast the buffer to the desired implementation. Extend to make creating encoders easier.

Nested Class Summary

Nested classes/interfaces inherited from interface LogEncoder

LogEncoder.AbstractEncoder<T>, LogEncoder.Buffer, LogEncoder.BufferHints, LogEncoder.Builder, LogEncoder.EncoderProvider

Modifier and Type	Interface	Description
static class	LogEncoder.AbstractEncoder<T extends LogEncoder.Buffer>	Abstract encoder that will cast the buffer to the desired implementation.
static interface	LogEncoder.Buffer	Encoders buffer.
static interface	LogEncoder.BufferHints	Hints the output can pass to the encoder for creating buffers like max size and storage style of the buffer etc.
static final class	LogEncoder.Builder	Builds a LogEncoder out of a LogFormatter.
static interface	LogEncoder.EncoderProvider	Finds output based on URI.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractEncoder()	Do nothing constructor.

Method Summary

Modifier and Type	Method	Description
final LogEncoder.Buffer	buffer(LogEncoder.BufferHints hints)	Creates a new buffer.
protected abstract T	doBuffer(LogEncoder.BufferHints hints)	Create a specific buffer implementation.
protected abstract void	doEncode(LogEvent event, T buffer)	A type safe version of encode(LogEvent, Buffer).
final void	encode(LogEvent event, LogEncoder.Buffer buffer)	Encodes an event to the buffer.

Methods inherited from class Object

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

Constructor Details

AbstractEncoder

protected AbstractEncoder()

Do nothing constructor.

Method Details

doBuffer

protected abstract T doBuffer(LogEncoder.BufferHints hints)

Create a specific buffer implementation.

Parameters:

hints - buffer creation hints.

Returns:

buffer

doEncode

protected abstract void doEncode(LogEvent event,
 T buffer)

A type safe version of encode(LogEvent, Buffer).

Parameters:

event - event.

buffer - casted buffer.

buffer

public final LogEncoder.Buffer buffer(LogEncoder.BufferHints hints)

Description copied from interface: LogEncoder

Creates a new buffer. The encoder should not try to reuse buffers as that is the responsibility of the appender (and possibly LogOutput but usually not). Hints can be retrieved by call LogOutput.bufferHints().

Specified by:

buffer in interface LogEncoder

Parameters:

hints - hints are like size and storage type etc.

Returns:

a new buffer.

encode

public final void encode(LogEvent event,
 LogEncoder.Buffer buffer)

Description copied from interface: LogEncoder

Encodes an event to the buffer. It is recommended that the encoder call LogEncoder.Buffer.clear() before using.

Specified by:

encode in interface LogEncoder

Parameters:

event - log event.

buffer - buffer created from LogEncoder.buffer(BufferHints).