Package org.forgerock.api.enums

Enum Class PatchOperation

java.lang.Object

java.lang.Enum<PatchOperation>

org.forgerock.api.enums.PatchOperation

All Implemented Interfaces:

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

public enum PatchOperation
extends Enum<PatchOperation>

Represents all Patch operations.

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
ADD	Adds a field.
COPY	Copies a field.
INCREMENT	Increments a numeric field.
MOVE	Moves a field.
REMOVE	Removes a field.
REPLACE	Replaces a field.
TRANSFORM	Transforms a field.

Method Summary

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

ADD

public static final PatchOperation ADD

Adds a field.

REMOVE

public static final PatchOperation REMOVE

Removes a field.

REPLACE

public static final PatchOperation REPLACE

Replaces a field.

INCREMENT

public static final PatchOperation INCREMENT

Increments a numeric field.

MOVE

public static final PatchOperation MOVE

Moves a field.

COPY

public static final PatchOperation COPY

Copies a field.

TRANSFORM

public static final PatchOperation TRANSFORM

Transforms a field.

Method Details

values

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