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

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

public interface Layout<T extends Serializable>


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

Method Detail

format

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

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

formatAs

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

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

getHeader

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

Returns:
The header.

getFooter

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

Returns:
The footer.


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