public class LayoutWrappingEncoder<E> extends EncoderBase<E>
Constructor and Description |
---|
LayoutWrappingEncoder() |
Modifier and Type | Method and Description |
---|---|
byte[] |
encode(E event)
Encode an event as bytes.
|
byte[] |
footerBytes()
Get footer bytes.
|
java.nio.charset.Charset |
getCharset() |
Layout<E> |
getLayout() |
byte[] |
headerBytes()
Get header bytes.
|
boolean |
isStarted() |
void |
setCharset(java.nio.charset.Charset charset)
Set the charset to use when converting the string returned by the layout
into bytes.
|
void |
setImmediateFlush(boolean immediateFlush)
Sets the immediateFlush option.
|
void |
setLayout(Layout<E> layout) |
void |
setParent(Appender<?> parent)
This method allows RollingPolicy implementations to be aware of their
containing appender.
|
void |
start() |
void |
stop() |
addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getStatusManager, setContext
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, setContext
public java.nio.charset.Charset getCharset()
public void setCharset(java.nio.charset.Charset charset)
By default this property has the value
null which corresponds to
the system's default charset.
- Parameters:
charset
-
-
setImmediateFlush
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
-
headerBytes
public byte[] headerBytes()
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()
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)
Description copied from interface: Encoder
Encode an event as bytes.
-
isStarted
public boolean isStarted()
- Specified by:
isStarted
in interface LifeCycle
- Overrides:
isStarted
in class EncoderBase<E>
-
start
public void start()
- Specified by:
start
in interface LifeCycle
- Overrides:
start
in class EncoderBase<E>
-
stop
public void stop()
- Specified by:
stop
in interface LifeCycle
- Overrides:
stop
in class EncoderBase<E>
-
setParent
public void setParent(Appender<?> parent)
This method allows RollingPolicy implementations to be aware of their
containing appender.
- Parameters:
appender
-
Copyright © 2010 - 2023 Adobe. All Rights Reserved