Package org.forgerock.api.models

Enum Class Resource.AnnotatedTypeVariant

java.lang.Object

java.lang.Enum<Resource.AnnotatedTypeVariant>

org.forgerock.api.models.Resource.AnnotatedTypeVariant

All Implemented Interfaces:

Serializable, Comparable<Resource.AnnotatedTypeVariant>, java.lang.constant.Constable

Enclosing class:

Resource

public static enum Resource.AnnotatedTypeVariant
extends Enum<Resource.AnnotatedTypeVariant>

The variant of the annotated type. Allows the annotation processing to make assumptions about what type of operations are expected from this context of the type.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COLLECTION_RESOURCE_COLLECTION	A collection resource handler, collection endpoint (expect CAQ opererations).
COLLECTION_RESOURCE_INSTANCE	A collection resource handler, instance endpoint (expect CRUDPA operations).
REQUEST_HANDLER	A plain request handler (expects all operations).
SINGLETON_RESOURCE	A singleton resource handler.

Method Summary

Modifier and Type	Method	Description
static Resource.AnnotatedTypeVariant	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Resource.AnnotatedTypeVariant[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SINGLETON_RESOURCE

public static final Resource.AnnotatedTypeVariant SINGLETON_RESOURCE

A singleton resource handler. (expect RUDPA operations).

COLLECTION_RESOURCE_COLLECTION

public static final Resource.AnnotatedTypeVariant COLLECTION_RESOURCE_COLLECTION

A collection resource handler, collection endpoint (expect CAQ opererations).

COLLECTION_RESOURCE_INSTANCE

public static final Resource.AnnotatedTypeVariant COLLECTION_RESOURCE_INSTANCE

A collection resource handler, instance endpoint (expect CRUDPA operations).

REQUEST_HANDLER

public static final Resource.AnnotatedTypeVariant REQUEST_HANDLER

A plain request handler (expects all operations).

Method Details

values

public static Resource.AnnotatedTypeVariant[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Resource.AnnotatedTypeVariant valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null