org.forgerock.api.models

Class Delete

java.lang.Object

org.forgerock.api.models.Operation

org.forgerock.api.models.Delete

public final class Delete
extends Operation

Class that represents the Delete operation type in API descriptor.

Nested Class Summary

Nested Classes

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

Method Summary

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

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

delete

public static Delete.Builder delete()

Creates a new builder for Delete.

Returns:

New builder instance

allocateToResource

protected void allocateToResource(Resource.Builder resourceBuilder)

Allocates the Delete operation type to the given Resource Builder.

Specified by:

allocateToResource in class Operation

Parameters:

resourceBuilder - - Resource Builder to add the operation

fromAnnotation

public static Delete fromAnnotation(Delete delete,
                                    ApiDescription descriptor,
                                    Class<?> relativeType)

Builds a Delete object from the data in the Delete annotation.

Parameters:

delete - Delete annotation where the data stored

descriptor - The root descriptor to add definitions to.

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

Returns:

Delete instance