Module li.pitschmann.knx.core.plugin.audit

Package li.pitschmann.knx.core.plugin.audit

Enum FileAuditFormat

java.lang.Object

java.lang.Enum<FileAuditFormat>

li.pitschmann.knx.core.plugin.audit.FileAuditFormat

All Implemented Interfaces:

Serializable, Comparable<FileAuditFormat>

public enum FileAuditFormat
extends Enum<FileAuditFormat>

Format for FileAuditPlugin

JSON and TSV are supported.

Enum Constant Summary

Enum Constants

Enum Constant	Description
JSON	Audit format should be in JSON format.
TSV	Audit format should be in TSV text format

Method Summary

Modifier and Type	Method	Description
String	escape(Object str)
String	getBodyTemplate()
String	getErrorTemplate()
String	getHeader()
String	getSignalTemplate()
static FileAuditFormat	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FileAuditFormat[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

JSON

public static final FileAuditFormat JSON

Audit format should be in JSON format.

TSV

public static final FileAuditFormat TSV

Audit format should be in TSV text format

Method Detail

values

public static FileAuditFormat[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FileAuditFormat c : FileAuditFormat.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FileAuditFormat valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getHeader

public String getHeader()

getSignalTemplate

public String getSignalTemplate()

getBodyTemplate

public String getBodyTemplate()

getErrorTemplate

public String getErrorTemplate()

escape

public String escape(@Nullable
                     Object str)