org.forgerock.api.models

Class Create

java.lang.Object

org.forgerock.api.models.Operation

org.forgerock.api.models.Create

public final class Create
extends Operation

Class that represents the Create Operation type in API descriptor.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Create.Builder Builder for the Create.

Method Summary

Modifier and Type	Method and Description
protected void	allocateToResource(Resource.Builder resourceBuilder) Allocates the Create operation type to the given Resource Builder.
static Create.Builder	create() Creates a new builder for Create.
boolean	equals(Object o)
static Create	fromAnnotation(Create create, boolean instanceOperations, ApiDescription descriptor, Class<?> relativeType) Builds a Create object from the data in the annotation.
CreateMode	getMode() Getter of the mode.
int	hashCode()
Boolean	isSingleton() Informs if operation creates singleton resources.

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

getMode

public CreateMode getMode()

Getter of the mode.

Returns:

Mode

isSingleton

public Boolean isSingleton()

Informs if operation creates singleton resources.

Returns:

true if operation creates singleton resources and false otherwise

create

public static Create.Builder create()

Creates a new builder for Create.

Returns:

New builder instance

allocateToResource

protected void allocateToResource(Resource.Builder resourceBuilder)

Allocates the Create operation type to the given Resource Builder.

Specified by:

allocateToResource in class Operation

Parameters:

resourceBuilder - - Resource Builder to add the operation

fromAnnotation

public static Create fromAnnotation(Create create,
                                    boolean instanceOperations,
                                    ApiDescription descriptor,
                                    Class<?> relativeType)

Builds a Create object from the data in the annotation.

Parameters:

create - Create annotation that holds the data

instanceOperations - True if the resource is performing instance operations.

descriptor - The root descriptor to add definitions to.

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

Returns:

Create instance

equals

public boolean equals(Object o)

Overrides:

equals in class Operation

hashCode

public int hashCode()

Overrides:

hashCode in class Operation