Enum Class StructuredDataPolicy

java.lang.Object

java.lang.Enum<StructuredDataPolicy>

com.github.palindromicity.syslog.StructuredDataPolicy

All Implemented Interfaces:

Serializable, Comparable<StructuredDataPolicy>, java.lang.constant.Constable

public enum StructuredDataPolicy
extends Enum<StructuredDataPolicy>

Policy for the handling of StructuredData.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FLATTEN	The Structured Data will be flattened per the KeyProvider provided values.
MAP_OF_MAPS	The Structured Data will be returned as a Map field named structuredData.

Method Summary

Modifier and Type	Method	Description
static StructuredDataPolicy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StructuredDataPolicy[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FLATTEN

public static final StructuredDataPolicy FLATTEN

The Structured Data will be flattened per the KeyProvider provided values.

MAP_OF_MAPS

public static final StructuredDataPolicy MAP_OF_MAPS

The Structured Data will be returned as a Map field named structuredData. Each map entry will have the value of the Structured Data ID, and a value of a map of each element param name and value

Method Details

values

public static StructuredDataPolicy[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static StructuredDataPolicy valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null