Patch (OpenAM Server Only 7.4.1 Documentation)

java.lang.Object
- org.forgerock.api.models.Operation
- - org.forgerock.api.models.Patch

```
public final class Patch
extends Operation
```
Class that represents the Patch operation type in API descriptor.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Patch.Builder
Builder to help construct the Patch.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`allocateToResource(Resource.Builder resourceBuilder)`	Allocates the Patch operation type to the given Resource Builder.
`boolean`	`equals(Object o)`
`static Patch`	`fromAnnotation(Patch patch, ApiDescription descriptor, Class<?> relativeType)`	Builds a Patch object from the data stored in the annotation.
`PatchOperation[]`	`getOperations()`	Getter for supported Patch operations.
`int`	`hashCode()`
`static Patch.Builder`	`patch()`	Creates a new builder for Patch.

Methods inherited from class org.forgerock.api.models.Operation
getApiErrors, getDescription, getParameters, getStability, getSupportedLocales

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getOperations
```
public PatchOperation[] getOperations()
```
    Getter for supported Patch operations.
    
    Returns:
    
    Supported Patch operations
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Operation
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Operation
  - patch
```
public static Patch.Builder patch()
```
    Creates a new builder for Patch.
    
    Returns:
    
    New builder instance
  - allocateToResource
```
protected void allocateToResource(Resource.Builder resourceBuilder)
```
    Allocates the Patch operation type to the given Resource Builder.
    
    Specified by:
    
    allocateToResource in class Operation
    
    Parameters:
    
    resourceBuilder - - Resource Builder to add the operation
  - fromAnnotation
```
public static Patch fromAnnotation(Patch patch,
                                   ApiDescription descriptor,
                                   Class<?> relativeType)
```
    Builds a Patch object from the data stored in the annotation.
    
    Parameters:
    
    patch - Patch annotation that holds the data
    
    descriptor - The root descriptor to add definitions to.
    
    relativeType - The type relative to which schema resources should be resolved.
    
    Returns:
    
    Patch instance