Package com.helixframework.delta

Enum Class InclusionReason

java.lang.Object

java.lang.Enum<InclusionReason>

com.helixframework.delta.InclusionReason

All Implemented Interfaces:

Serializable, Comparable<InclusionReason>, Constable

public enum InclusionReason
extends Enum<InclusionReason>

Explains why a path appears in the delta output.

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
ARRAY_CONTEXT_REQUIRED	Array structure was retained to preserve positional context.
KEY_ADDED	The key exists only in the after document.
KEY_REMOVED	The key exists only in the before document.
PARENT_RETAINED_FOR_TRACEABILITY	Parent container was retained to preserve reachability to a changed node.
TYPE_CHANGED	The node type changed at the path.
VALUE_CHANGED	The value at the path changed in place.

Method Summary

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

VALUE_CHANGED

public static final InclusionReason VALUE_CHANGED

The value at the path changed in place.

KEY_ADDED

public static final InclusionReason KEY_ADDED

The key exists only in the after document.

KEY_REMOVED

public static final InclusionReason KEY_REMOVED

The key exists only in the before document.

TYPE_CHANGED

public static final InclusionReason TYPE_CHANGED

The node type changed at the path.

ARRAY_CONTEXT_REQUIRED

public static final InclusionReason ARRAY_CONTEXT_REQUIRED

Array structure was retained to preserve positional context.

PARENT_RETAINED_FOR_TRACEABILITY

public static final InclusionReason PARENT_RETAINED_FOR_TRACEABILITY

Parent container was retained to preserve reachability to a changed node.

Method Details

values

public static InclusionReason[] 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 InclusionReason 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