Package org.apache.log4j.bridge

Class LayoutWrapper

java.lang.Object

org.apache.log4j.Layout

org.apache.log4j.bridge.LayoutWrapper

public class LayoutWrapper
extends Layout

Bridge between the Log4j 1 Layout and a Log4j 2 Layout.

Field Summary

Fields

Modifier and Type	Field	Description
private Layout<?>	layout

Fields inherited from class org.apache.log4j.Layout

LINE_SEP, LINE_SEP_LEN

Constructor Summary

Constructors

Constructor	Description
LayoutWrapper(Layout<?> layout)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
static Layout	adapt(Layout<?> layout)	Adapts a Log4j 2.x layout into a Log4j 1.x layout.
java.lang.String	format(LoggingEvent event)	Implement this method to create your own layout format.
Layout<?>	getLayout()	Unwraps.
boolean	ignoresThrowable()	If the layout handles the throwable object contained within LoggingEvent, then the layout should return false.
java.lang.String	toString()

Methods inherited from class org.apache.log4j.Layout

getContentType, getFooter, getHeader

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

layout

private final Layout<?> layout

Constructor Detail

LayoutWrapper

public LayoutWrapper(Layout<?> layout)

Constructs a new instance.

Parameters:

layout - The layout to wrap.

Method Detail

adapt

public static Layout adapt(Layout<?> layout)

Adapts a Log4j 2.x layout into a Log4j 1.x layout. Applying this method to the result of LayoutAdapter.adapt(Layout) should return the original Log4j 1.x layout.

Parameters:

layout - a Log4j 2.x layout

Returns:

a Log4j 1.x layout or null if the parameter is null

format

public java.lang.String format(LoggingEvent event)

Description copied from class: Layout

Implement this method to create your own layout format.

Specified by:

format in class Layout

Parameters:

event - The LoggingEvent.

Returns:

The formatted LoggingEvent.

getLayout

public Layout<?> getLayout()

Unwraps.

Returns:

The wrapped object.

ignoresThrowable

public boolean ignoresThrowable()

Description copied from class: Layout

If the layout handles the throwable object contained within LoggingEvent, then the layout should return false. Otherwise, if the layout ignores throwable object, then the layout should return true. If ignoresThrowable is true, the appender is responsible for rendering the throwable.

The SimpleLayout, TTCCLayout, PatternLayout all return true. The XMLLayout returns false.

Specified by:

ignoresThrowable in class Layout

Returns:

true if the Layout ignores Throwables.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object