com.enremmeta.util

Class DelimLayout

java.lang.Object

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

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

com.enremmeta.util.DelimLayout

All Implemented Interfaces:

EnremmetaConstants, Serializable, org.apache.logging.log4j.core.Layout<String>

@Plugin(name="DelimLayout",
        category="Core",
        elementType="layout",
        printObject=true)
public final class DelimLayout
extends org.apache.logging.log4j.core.layout.AbstractStringLayout
implements EnremmetaConstants

Delimited layout.

Author:

Gregory Golberg (grisha@alum.mit.edu) Copyright © Enremmeta LLC 2014-2015. All Rights Reserved.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private char	delimiter
private String	nullChar
private char	secondaryDelimiter
private boolean	waitForFutures
private long	waitForFuturesTimeoutMillis

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

footer, header, LOGGER

Fields inherited from interface com.enremmeta.util.EnremmetaConstants

LOG_DELIMITER, LOG_LIST_DELIMITER, LOG_NULL_CHAR

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

ELEMENT_TYPE

Constructor Summary

Constructors

Constructor and Description
DelimLayout()
DelimLayout(char delimiter, char secondaryDelimiter, String nullChar)
DelimLayout(char delimiter, char secondaryDelimiter, String nullChar, boolean waitForFutures, long waitForFuturesTimeoutMillis)

Method Summary

Modifier and Type	Method and Description
static DelimLayout	createLayout(char delimiter, char secondaryDelimiter, String nullChar, boolean waitForFutures, long waitForFuturesTimeoutMillis)
String	getNullChar() What to write instead of null (e.g., in some cases it's convenient to log "-", just like NGINX does).
String	toSerializable(org.apache.logging.log4j.core.LogEvent event) Formats the event as an Object that can be serialized.

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

getBytes, getCharset, getContentType, toByteArray

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

getContentFormat, getFooter, getHeader

Methods inherited from class java.lang.Object

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

Field Detail

waitForFutures

private final boolean waitForFutures

waitForFuturesTimeoutMillis

private final long waitForFuturesTimeoutMillis

delimiter

private final char delimiter

secondaryDelimiter

private final char secondaryDelimiter

nullChar

private String nullChar

Constructor Detail

DelimLayout

public DelimLayout()

DelimLayout

public DelimLayout(char delimiter,
                   char secondaryDelimiter,
                   String nullChar)

DelimLayout

public DelimLayout(char delimiter,
                   char secondaryDelimiter,
                   String nullChar,
                   boolean waitForFutures,
                   long waitForFuturesTimeoutMillis)

Parameters:

delimiter - pretty obvious

secondaryDelimiter - delimiter for collections

nullChar - what to replace null with.

waitForFutures - whether to wait for Future objects to finish getting the underlying object.

Method Detail

getNullChar

public String getNullChar()

What to write instead of null (e.g., in some cases it's convenient to log "-", just like NGINX does).

createLayout

@PluginFactory
public static DelimLayout createLayout(@PluginAttribute(value="delimiter")
                                                      char delimiter,
                                                      @PluginAttribute(value="secondaryDelimiter")
                                                      char secondaryDelimiter,
                                                      @PluginAttribute(value="nullChar")
                                                      String nullChar,
                                                      @PluginAttribute(value="waitForFutures")
                                                      boolean waitForFutures,
                                                      @PluginAttribute(value="waitForFuturesTimeoutMillis")
                                                      long waitForFuturesTimeoutMillis)

toSerializable

public String toSerializable(org.apache.logging.log4j.core.LogEvent event)

Formats the event as an Object that can be serialized.

Specified by:

toSerializable in interface org.apache.logging.log4j.core.Layout<String>

Parameters:

event - The Logging Event.

Returns:

The formatted event.