de.aristaflow.adept2.base.registry

Class CSVFormatter

java.lang.Object

java.util.logging.Formatter

de.aristaflow.adept2.base.registry.CSVFormatter

public class CSVFormatter
extends java.util.logging.Formatter

This class formats a LogRecord to a CSV-record as specified in RFC 4180. Most of the fields of a record will be AristaFlow-specific (template ID, instance ID, information on the session token, ...) if provided by the log record.

Author:

Ulrich Kreher

Constructor Summary

Constructors

Constructor and Description
CSVFormatter() Creates a new formatter for CSV.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	escape(java.lang.String string) Checks whether the designated string contains control characters (field or record separators) and escapes them if required.
protected java.lang.String	escapedString(java.lang.String string) Escapes all control characters in the designated string and encloses the string with the corresponding characters.
protected boolean	escapeRequired(java.lang.String string) Gets whether the designated string contains control characters (field or record separators) and therefore needs escaping.
java.lang.String	format(java.util.logging.LogRecord record)
java.lang.String	getHead(java.util.logging.Handler h) Gets the header line containing the names of the fields of a record as needed for a CSV.

Methods inherited from class java.util.logging.Formatter

formatMessage, getTail

Methods inherited from class java.lang.Object

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

Constructor Detail

CSVFormatter

public CSVFormatter()

Creates a new formatter for CSV.

Method Detail

format

public java.lang.String format(java.util.logging.LogRecord record)

Specified by:

format in class java.util.logging.Formatter

getHead

public java.lang.String getHead(java.util.logging.Handler h)

Gets the header line containing the names of the fields of a record as needed for a CSV.

Overrides:

getHead in class java.util.logging.Formatter

escape

protected java.lang.String escape(java.lang.String string)

Checks whether the designated string contains control characters (field or record separators) and escapes them if required.

Parameters:

string - The string to check for required escaping.

Returns:

The designated string with the corresponding characters escaped if required.

escapeRequired

protected boolean escapeRequired(java.lang.String string)

Gets whether the designated string contains control characters (field or record separators) and therefore needs escaping.

Parameters:

string - The string to check for required escaping.

Returns:

Whether the designated string contains control characters (field or record separators) and therefore needs escaping.

escapedString

protected java.lang.String escapedString(java.lang.String string)

Escapes all control characters in the designated string and encloses the string with the corresponding characters.

Parameters:

string - The string to enclose within the corresponding characters and to escape the used control characters.

Returns:

The designated string enclosed and having the appropriate characters escaped.