Package ch.qos.logback.core
Interface Layout<E>
-
- All Superinterfaces:
ContextAware,LifeCycle
- All Known Implementing Classes:
EchoLayout,HTMLLayout,HTMLLayoutBase,LayoutBase,PatternLayout,PatternLayoutBase,TTLLLayout,XMLLayout
@Deprecated(since="2022-01-27") public interface Layout<E> extends ContextAware, LifeCycle
Deprecated.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description StringdoLayout(E event)Deprecated.Transform an event (of type Object) and return it as a String after appropriate formatting.StringgetContentType()Deprecated.Returns the content type as appropriate for the implementation.StringgetFileFooter()Deprecated.Return the file footer for this layout.StringgetFileHeader()Deprecated.Return the file header for this layout.StringgetPresentationFooter()Deprecated.Return the footer of the logging event formatting.StringgetPresentationHeader()Deprecated.Return the header of the logging event formatting.-
Methods inherited from interface ch.qos.logback.core.spi.ContextAware
addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, setContext
-
-
-
-
Method Detail
-
doLayout
String doLayout(E event)
Deprecated.Transform an event (of type Object) and return it as a String after appropriate formatting.Taking in an object and returning a String is the least sophisticated way of formatting events. However, it is remarkably CPU-effective.
- Parameters:
event- The event to format- Returns:
- the event formatted as a String
-
getFileHeader
String getFileHeader()
Deprecated.Return the file header for this layout. The returned value may be null.- Returns:
- The header.
-
getPresentationHeader
String getPresentationHeader()
Deprecated.Return the header of the logging event formatting. The returned value may be null.- Returns:
- The header.
-
getPresentationFooter
String getPresentationFooter()
Deprecated.Return the footer of the logging event formatting. The returned value may be null.- Returns:
- The footer.
-
getFileFooter
String getFileFooter()
Deprecated.Return the file footer for this layout. The returned value may be null.- Returns:
- The footer.
-
getContentType
String getContentType()
Deprecated.Returns the content type as appropriate for the implementation.- Returns:
-
-