org.apache.logging.log4j.core.layout

Class AbstractCsvLayout

java.lang.Object

org.apache.logging.log4j.core.layout.AbstractLayout<String>

org.apache.logging.log4j.core.layout.AbstractStringLayout

org.apache.logging.log4j.core.layout.AbstractCsvLayout

All Implemented Interfaces:

LocationAware, Layout<String>, Encoder<LogEvent>, StringLayout

Direct Known Subclasses:

CsvLogEventLayout, CsvParameterLayout

public abstract class AbstractCsvLayout
extends AbstractStringLayout

A superclass for Comma-Separated Value (CSV) layouts. Depends on Apache Commons CSV 1.2.

Since:

2.4

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.logging.log4j.core.layout.AbstractStringLayout

AbstractStringLayout.Builder<B extends AbstractStringLayout.Builder<B>>, AbstractStringLayout.Serializer, AbstractStringLayout.Serializer2

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DEFAULT_CHARSET
protected static String	DEFAULT_FORMAT

Fields inherited from class org.apache.logging.log4j.core.layout.AbstractStringLayout

DEFAULT_STRING_BUILDER_SIZE, MAX_STRING_BUILDER_SIZE

Fields inherited from class org.apache.logging.log4j.core.layout.AbstractLayout

configuration, eventCount, footer, header, LOGGER

Fields inherited from interface org.apache.logging.log4j.core.Layout

ELEMENT_TYPE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCsvLayout(Configuration config, Charset charset, org.apache.commons.csv.CSVFormat csvFormat, String header, String footer)

Method Summary

Modifier and Type	Method and Description
protected static org.apache.commons.csv.CSVFormat	createFormat(String format, Character delimiter, Character escape, Character quote, org.apache.commons.csv.QuoteMode quoteMode, String nullString, String recordSeparator)
String	getContentType() Returns the content type output by this layout.
org.apache.commons.csv.CSVFormat	getFormat()

Methods inherited from class org.apache.logging.log4j.core.layout.AbstractStringLayout

getBytes, getCharset, getFooter, getFooterSerializer, getHeader, getHeaderSerializer, getStringBuilder, getStringBuilderEncoder, requiresLocation, serializeToBytes, serializeToString, toByteArray, trimToMaxSize

Methods inherited from class org.apache.logging.log4j.core.layout.AbstractLayout

encode, getConfiguration, getContentFormat, markEvent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.logging.log4j.core.Layout

getContentFormat, toSerializable

Methods inherited from interface org.apache.logging.log4j.core.layout.Encoder

encode

Field Detail

DEFAULT_CHARSET

protected static final String DEFAULT_CHARSET

See Also:

Constant Field Values

DEFAULT_FORMAT

protected static final String DEFAULT_FORMAT

See Also:

Constant Field Values

Constructor Detail

AbstractCsvLayout

protected AbstractCsvLayout(Configuration config,
                            Charset charset,
                            org.apache.commons.csv.CSVFormat csvFormat,
                            String header,
                            String footer)

Method Detail

createFormat

protected static org.apache.commons.csv.CSVFormat createFormat(String format,
                                                               Character delimiter,
                                                               Character escape,
                                                               Character quote,
                                                               org.apache.commons.csv.QuoteMode quoteMode,
                                                               String nullString,
                                                               String recordSeparator)

getContentType

public String getContentType()

Description copied from interface: Layout

Returns the content type output by this layout. The base class returns "text/plain".

Specified by:

getContentType in interface Layout<String>

Overrides:

getContentType in class AbstractStringLayout

Returns:

The default content type for Strings.

getFormat

public org.apache.commons.csv.CSVFormat getFormat()