Package org.forgerock.api.models

Class Read

java.lang.Object

org.forgerock.api.models.Operation

org.forgerock.api.models.Read

public final class Read
extends Operation

Class that represents the Read Operation type in API descriptor.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Read.Builder	Builder to help construct the Read.

Method Summary

Modifier and Type	Method	Description
protected void	allocateToResource(Resource.Builder resourceBuilder)	Allocates the Read operation type to the given Resource Builder.
static Read	fromAnnotation(Read read, ApiDescription descriptor, Class<?> relativeType)	Builds a Read object from the data in the read annotation.
static Read.Builder	read()	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 Detail

read

public static Read.Builder read()

Creates a new builder for Operation.

Returns:

New builder instance

allocateToResource

protected void allocateToResource(Resource.Builder resourceBuilder)

Allocates the Read operation type to the given Resource Builder.

Specified by:

allocateToResource in class Operation

Parameters:

resourceBuilder - - Resource Builder to add the operation

fromAnnotation

public static Read fromAnnotation(Read read,
                                  ApiDescription descriptor,
                                  Class<?> relativeType)

Builds a Read object from the data in the read annotation.

Parameters:

read - Read 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:

Read instance