PatchOperation (OpenAM Server Only 6.5.5 Documentation)

java.lang.Object
- java.lang.Enum<PatchOperation>
- - org.forgerock.api.enums.PatchOperation

All Implemented Interfaces:

Serializable, Comparable<PatchOperation>
```
public enum PatchOperation
extends Enum<PatchOperation>
```
Represents all Patch operations.

Enum Constant Summary

Enum Constants
Enum Constant and 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

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static PatchOperation`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static PatchOperation[]`	`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
  - 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 Detail
  - values
```
public static PatchOperation[] 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 (PatchOperation c : PatchOperation.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static PatchOperation 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

Enum PatchOperation

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ADD

REMOVE

REPLACE

INCREMENT

MOVE

COPY

TRANSFORM

Method Detail

values

valueOf