Package org.forgerock.api.models

Class Update

java.lang.Object

org.forgerock.api.models.Operation

org.forgerock.api.models.Update

public final class Update
extends Operation

Class that represents the Create Operation type in API descriptor.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Update.Builder	Builder to help construct Update.

Method Summary

Modifier and Type	Method	Description
protected void	allocateToResource(Resource.Builder resourceBuilder)	Allocates the Update operation type to the given Resource Builder.
static Update	fromAnnotation(Update update, ApiDescription descriptor, Class<?> relativeType)	Builds an Update object from the data stored in the annotation.
static Update.Builder	update()	Creates a new builder for Operation.

Methods inherited from class org.forgerock.api.models.Operation

equals, getApiErrors, getDescription, getParameters, getStability, getSupportedLocales, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Details

update

public static Update.Builder update()

Creates a new builder for Operation.

Returns:

New builder instance

allocateToResource

protected void allocateToResource(Resource.Builder resourceBuilder)

Allocates the Update operation type to the given Resource Builder.

Specified by:

allocateToResource in class Operation

Parameters:

resourceBuilder - - Resource Builder to add the operation

fromAnnotation

public static Update fromAnnotation(Update update,
 ApiDescription descriptor,
 Class<?> relativeType)

Builds an Update object from the data stored in the annotation.

Parameters:

update - Update annotation that stores the data

descriptor - The root descriptor to add definitions to.

relativeType - The type relative to which schema resources should be resolved.

Returns:

Update instance