Package com.unboundid.scim2.common.types

Enum AttributeDefinition.Returned

java.lang.Object

java.lang.Enum<AttributeDefinition.Returned>

com.unboundid.scim2.common.types.AttributeDefinition.Returned

All Implemented Interfaces:

Serializable, Comparable<AttributeDefinition.Returned>

Enclosing class:

AttributeDefinition

public static enum AttributeDefinition.Returned
extends Enum<AttributeDefinition.Returned>

This enum is used to describe the when an attribute is returned from scim methods.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALWAYS	Indicates that the attribute is always returned.
DEFAULT	Indicates that the attribute is returned by default.
NEVER	Indicates that the attribute is never returned.
REQUEST	Indicates that the attribute is only returned if requested.

Method Summary

Modifier and Type	Method	Description
static AttributeDefinition.Returned	fromName(String name)	finds the return constraint by name.
String	getName()	Gets the name of the return constraint.
static AttributeDefinition.Returned	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AttributeDefinition.Returned[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ALWAYS

public static final AttributeDefinition.Returned ALWAYS

Indicates that the attribute is always returned.

NEVER

public static final AttributeDefinition.Returned NEVER

Indicates that the attribute is never returned.

DEFAULT

public static final AttributeDefinition.Returned DEFAULT

Indicates that the attribute is returned by default.

REQUEST

public static final AttributeDefinition.Returned REQUEST

Indicates that the attribute is only returned if requested.

Method Detail

values

public static AttributeDefinition.Returned[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AttributeDefinition.Returned c : AttributeDefinition.Returned.values())
    System.out.println(c);

Returns:

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

valueOf

public static AttributeDefinition.Returned valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getName

public String getName()

Gets the name of the return constraint.

Returns:

the name of the return constraint.

fromName

public static AttributeDefinition.Returned fromName(String name)
                                             throws BadRequestException

finds the return constraint by name. Throws a runtime exception if the constraint cannot be found because an invalid name was given.

Parameters:

name - the name of the return constraint.

Returns:

the enum value for the given name.

Throws:

BadRequestException - if the name of the return constraint is invalid.