com.github.palindromicity.syslog

Enum NilPolicy

java.lang.Object

java.lang.Enum<NilPolicy>

com.github.palindromicity.syslog.NilPolicy

All Implemented Interfaces:

Serializable, Comparable<NilPolicy>

public enum NilPolicy
extends Enum<NilPolicy>

Policies available for handling NIL '-' values.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DASH a nil value will result in a '-' symbol in the map.
NULL a nil value will result in a null value in the map.
OMIT a nil value will result msg part being omitted from the map.

Method Summary

Modifier and Type	Method and Description
static NilPolicy	valueOf(String name) Returns the enum constant of this type with the specified name.
static NilPolicy[]	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

OMIT

public static final NilPolicy OMIT

a nil value will result msg part being omitted from the map.

NULL

public static final NilPolicy NULL

a nil value will result in a null value in the map.

DASH

public static final NilPolicy DASH

a nil value will result in a '-' symbol in the map.

Method Detail

values

public static NilPolicy[] 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 (NilPolicy c : NilPolicy.values())
    System.out.println(c);

Returns:

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

valueOf

public static NilPolicy 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