Logback Core Module 1.5.1 · ch.qos.logback.core.encoder.LayoutWrappingEncoder

Modifier and Type	Field and Description
private Charset	charset The charset to use when converting a String into bytes.
pack-priv Boolean	immediateFlush
protected Layout<E>	layout
pack-priv ContextAware	parent

Access	Constructor and Description
public	LayoutWrappingEncoder()

Method Summary

Modifier and Type	Method and Description
private void	appendIfNotNull(StringBuilder sb, String s)
private byte[]	convertToBytes(String s)
public byte[]	encode(E event) Implements ch.qos.logback.core.encoder.Encoder.encode. Encode an event as bytes.
public byte[]	footerBytes() Implements ch.qos.logback.core.encoder.Encoder.footerBytes. Get footer bytes.
public Charset	getCharset()
public Layout<E>	getLayout()
public byte[]	headerBytes() Implements ch.qos.logback.core.encoder.Encoder.headerBytes. Get header bytes.
public boolean	isStarted() Overrides ch.qos.logback.core.encoder.EncoderBase.isStarted. Implements ch.qos.logback.core.spi.LifeCycle.isStarted.
public void	setCharset(Charset charset) Set the charset to use when converting the string returned by the layout into bytes.
public void	setImmediateFlush(boolean immediateFlush) Sets the immediateFlush option.
public void	setLayout(Layout<E> layout)
public void	setParent(ContextAware parent) This method allows RollingPolicy implementations to be aware of their containing appender.
public void	start() Overrides ch.qos.logback.core.encoder.EncoderBase.start. Implements ch.qos.logback.core.spi.LifeCycle.start.
public void	stop() Overrides ch.qos.logback.core.encoder.EncoderBase.stop. Implements ch.qos.logback.core.spi.LifeCycle.stop.

charset	back to summary
private Charset charset The charset to use when converting a String into bytes. By default this property has the value `null` which corresponds to the system's default charset.

immediateFlush	back to summary
pack-priv Boolean immediateFlush

layout	back to summary
protected Layout<E> layout

parent	back to summary
pack-priv ContextAware parent

LayoutWrappingEncoder	back to summary
public LayoutWrappingEncoder()

Method Detail

appendIfNotNull	back to summary
private void appendIfNotNull(StringBuilder sb, String s)

convertToBytes	back to summary
private byte[] convertToBytes(String s)

encode	back to summary
public byte[] encode(E event) Implements ch.qos.logback.core.encoder.Encoder.encode. Doc from ch.qos.logback.core.encoder.Encoder.encode. Encode an event as bytes.

encode

back to summary

public byte[] encode(E event)

Implements ch.qos.logback.core.encoder.Encoder.encode.

Doc from ch.qos.logback.core.encoder.Encoder.encode.

Encode an event as bytes.

footerBytes	back to summary
public byte[] footerBytes() Implements ch.qos.logback.core.encoder.Encoder.footerBytes. Doc from ch.qos.logback.core.encoder.Encoder.footerBytes. Get footer bytes. This method is typically called prior to the closing of the stream where events are written. Returns:byte[] footer bytes. Null values are allowed. Annotations @Override

footerBytes

back to summary

public byte[] footerBytes()

Implements ch.qos.logback.core.encoder.Encoder.footerBytes.

Doc from ch.qos.logback.core.encoder.Encoder.footerBytes.

Get footer bytes. This method is typically called prior to the closing of the stream where events are written.

Returns:byte[]

footer bytes. Null values are allowed.

Annotations

@Override

getCharset	back to summary
public Charset getCharset()

getLayout	back to summary
public Layout<E> getLayout()

headerBytes	back to summary
public byte[] headerBytes() Implements ch.qos.logback.core.encoder.Encoder.headerBytes. Doc from ch.qos.logback.core.encoder.Encoder.headerBytes. Get header bytes. This method is typically called upon opening of an output stream. Returns:byte[] header bytes. Null values are allowed. Annotations @Override

headerBytes

back to summary

public byte[] headerBytes()

Implements ch.qos.logback.core.encoder.Encoder.headerBytes.

Doc from ch.qos.logback.core.encoder.Encoder.headerBytes.

Get header bytes. This method is typically called upon opening of an output stream.

Returns:byte[]

header bytes. Null values are allowed.

Annotations

@Override

isStarted	back to summary
public boolean isStarted() Overrides ch.qos.logback.core.encoder.EncoderBase.isStarted. Implements ch.qos.logback.core.spi.LifeCycle.isStarted.

isStarted

back to summary

public boolean isStarted()

Overrides ch.qos.logback.core.encoder.EncoderBase.isStarted.

Implements ch.qos.logback.core.spi.LifeCycle.isStarted.

setCharset back to summary

setCharset	back to summary
public void setCharset(Charset charset) Set the charset to use when converting the string returned by the layout into bytes. By default this property has the value `null` which corresponds to the system's default charset.

public void setCharset(Charset charset)

Set the charset to use when converting the string returned by the layout into bytes.

By default this property has the value null which corresponds to the system's default charset.

setImmediateFlush	back to summary
public void setImmediateFlush(boolean immediateFlush) Sets the immediateFlush option. The default value for immediateFlush is 'true'. If set to true, the doEncode() method will immediately flush the underlying OutputStream. Although immediate flushing is safer, it also significantly degrades logging throughput. Since 1.0.3

setImmediateFlush

back to summary

public void setImmediateFlush(boolean immediateFlush)

Sets the immediateFlush option. The default value for immediateFlush is 'true'. If set to true, the doEncode() method will immediately flush the underlying OutputStream. Although immediate flushing is safer, it also significantly degrades logging throughput.

Since: 1.0.3

setLayout	back to summary
public void setLayout(Layout<E> layout)

setParent	back to summary
public void setParent(ContextAware parent) This method allows RollingPolicy implementations to be aware of their containing appender.

start	back to summary
public void start() Overrides ch.qos.logback.core.encoder.EncoderBase.start. Implements ch.qos.logback.core.spi.LifeCycle.start.

start

back to summary

public void start()

Overrides ch.qos.logback.core.encoder.EncoderBase.start.

Implements ch.qos.logback.core.spi.LifeCycle.start.

stop	back to summary
public void stop() Overrides ch.qos.logback.core.encoder.EncoderBase.stop. Implements ch.qos.logback.core.spi.LifeCycle.stop.

stop

back to summary

public void stop()

Overrides ch.qos.logback.core.encoder.EncoderBase.stop.

Implements ch.qos.logback.core.spi.LifeCycle.stop.

public Class LayoutWrappingEncoder<E>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail