Package ch.qos.logback.core.encoder
Class LayoutWrappingEncoder<E>
- java.lang.Object
-
- ch.qos.logback.core.spi.ContextAwareBase
-
- ch.qos.logback.core.encoder.EncoderBase<E>
-
- ch.qos.logback.core.encoder.LayoutWrappingEncoder<E>
-
- All Implemented Interfaces:
Encoder<E>
,ContextAware
,LifeCycle
- Direct Known Subclasses:
PatternLayoutEncoderBase
@Deprecated(since="2022-01-27") public class LayoutWrappingEncoder<E> extends EncoderBase<E>
Deprecated.
-
-
Constructor Summary
Constructors Constructor Description LayoutWrappingEncoder()
Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description byte[]
encode(E event)
Deprecated.Encode an event as bytes.byte[]
footerBytes()
Deprecated.Get footer bytes.java.nio.charset.Charset
getCharset()
Deprecated.Layout<E>
getLayout()
Deprecated.byte[]
headerBytes()
Deprecated.Get header bytes.boolean
isStarted()
Deprecated.void
setCharset(java.nio.charset.Charset charset)
Deprecated.Set the charset to use when converting the string returned by the layout into bytes.void
setImmediateFlush(boolean immediateFlush)
Deprecated.Sets the immediateFlush option.void
setLayout(Layout<E> layout)
Deprecated.void
setParent(ContextAware parent)
Deprecated.This method allows RollingPolicy implementations to be aware of their containing appender.void
start()
Deprecated.void
stop()
Deprecated.-
Methods inherited from class ch.qos.logback.core.spi.ContextAwareBase
addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getStatusManager, setContext
-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface ch.qos.logback.core.spi.ContextAware
addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, setContext
-
-
-
-
Method Detail
-
getCharset
public java.nio.charset.Charset getCharset()
Deprecated.
-
setCharset
public void setCharset(java.nio.charset.Charset charset)
Deprecated.Set the charset to use when converting the string returned by the layout into bytes. By default this property has the valuenull which corresponds to the system's default charset.
- Parameters:
charset
-
-
setImmediateFlush
public void setImmediateFlush(boolean immediateFlush)
Deprecated.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
-
headerBytes
public byte[] headerBytes()
Deprecated.Description copied from interface:Encoder
Get header bytes. This method is typically called upon opening of an output stream.- Returns:
- header bytes. Null values are allowed.
-
footerBytes
public byte[] footerBytes()
Deprecated.Description copied from interface:Encoder
Get footer bytes. This method is typically called prior to the closing of the stream where events are written.- Returns:
- footer bytes. Null values are allowed.
-
encode
public byte[] encode(E event)
Deprecated.Description copied from interface:Encoder
Encode an event as bytes.
-
isStarted
public boolean isStarted()
Deprecated.- Specified by:
isStarted
in interfaceLifeCycle
- Overrides:
isStarted
in classEncoderBase<E>
-
start
public void start()
Deprecated.- Specified by:
start
in interfaceLifeCycle
- Overrides:
start
in classEncoderBase<E>
-
stop
public void stop()
Deprecated.- Specified by:
stop
in interfaceLifeCycle
- Overrides:
stop
in classEncoderBase<E>
-
setParent
public void setParent(ContextAware parent)
Deprecated.This method allows RollingPolicy implementations to be aware of their containing appender.- Parameters:
parent
-
-
-