atg.service.validator

Enum ValidatorContext.UpdateMode

java.lang.Object

java.lang.Enum<ValidatorContext.UpdateMode>

atg.service.validator.ValidatorContext.UpdateMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ValidatorContext.UpdateMode>

Enclosing class:

ValidatorContext<E extends java.lang.Exception>

public static enum ValidatorContext.UpdateMode
extends java.lang.Enum<ValidatorContext.UpdateMode>

The update mode.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPLETE If the update mode is complete, all properties should be present in the input.
HYBRID In the hybrid mode, most input can be sparse, with the exception of Collections and Maps.
SPARSE If the update mode is sparse, any present input updatable properties will be updated.

Method Summary

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

COMPLETE

public static final ValidatorContext.UpdateMode COMPLETE

If the update mode is complete, all properties should be present in the input. Any unset updatable properties will be considered null, and Collections and Maps will be trimmed down to match input.

SPARSE

public static final ValidatorContext.UpdateMode SPARSE

If the update mode is sparse, any present input updatable properties will be updated. Any other properties will be left untouched. Collections and Maps can also be sparse, and sparse Collections and Maps will not be trimmed to match corresponding update vlues.

HYBRID

public static final ValidatorContext.UpdateMode HYBRID

In the hybrid mode, most input can be sparse, with the exception of Collections and Maps. Collections and maps, if there is an input value, those values must contain enough information to identify any existing items to be retained. This is the historical default for Cloud Commerce.

Method Detail

values

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

Returns:

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

valueOf

public static ValidatorContext.UpdateMode valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null