org.apache.logging.log4j.core
Interface Layout<T extends Serializable>

Type Parameters:
T - The Object type that will be returned on the toSerializable(LogEvent) call.
All Known Implementing Classes:
AbstractLayout, AbstractStringLayout, HTMLLayout, PatternLayout, RFC5424Layout, SerializedLayout, SyslogLayout, XMLLayout

public interface Layout<T extends Serializable>

Lays out a LogEvent in different formats. The formats are: byte[], or an implementor of Serializable, like byte[], String, and LogEvent.


Method Summary
 byte[] getFooter()
          Returns the format for the layout format.
 byte[] getHeader()
          Returns the header for the layout format.
 byte[] toByteArray(LogEvent event)
          Formats the event suitable for display.
 T toSerializable(LogEvent event)
          Formats the event as an Object that can be serialized.
 

Method Detail

getFooter

byte[] getFooter()
Returns the format for the layout format.

Returns:
The footer.

getHeader

byte[] getHeader()
Returns the header for the layout format.

Returns:
The header.

toByteArray

byte[] toByteArray(LogEvent event)
Formats the event suitable for display.

Parameters:
event - The Logging Event.
Returns:
The formatted event.

toSerializable

T toSerializable(LogEvent event)
Formats the event as an Object that can be serialized.

Parameters:
event - The Logging Event.
Returns:
The formatted event.


Copyright © 1999-2012 Apache Software Foundation. All Rights Reserved.