Package io.jans.scim.model.scim2

Enum AttributeDefinition.Mutability

java.lang.Object

java.lang.Enum<AttributeDefinition.Mutability>

io.jans.scim.model.scim2.AttributeDefinition.Mutability

All Implemented Interfaces:

Serializable, Comparable<AttributeDefinition.Mutability>

Enclosing class:

AttributeDefinition

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

An enum used to describe the mutability of an attribute.

Enum Constant Summary

Enum Constants

Enum Constant	Description
IMMUTABLE	The attribute can be read, and cannot be set after object creation (unless it was not provided in that moment).
READ_ONLY	The attribute can be read, but not written.
READ_WRITE	The attribute can be read, and written.
WRITE_ONLY	The attribute can only be written, and not read.

Method Summary

Modifier and Type	Method	Description
String	getName()	Returns the mutability value (readOnly, readWrite, etc.) as appears in section 7 of RFC7643.
static AttributeDefinition.Mutability	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AttributeDefinition.Mutability[]	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

READ_ONLY

public static final AttributeDefinition.Mutability READ_ONLY

The attribute can be read, but not written.

READ_WRITE

public static final AttributeDefinition.Mutability READ_WRITE

The attribute can be read, and written.

IMMUTABLE

public static final AttributeDefinition.Mutability IMMUTABLE

The attribute can be read, and cannot be set after object creation (unless it was not provided in that moment).

WRITE_ONLY

public static final AttributeDefinition.Mutability WRITE_ONLY

The attribute can only be written, and not read. This might be used for passwords for example.

Method Detail

values

public static AttributeDefinition.Mutability[] 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.Mutability c : AttributeDefinition.Mutability.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.Mutability 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()

Returns the mutability value (readOnly, readWrite, etc.) as appears in section 7 of RFC7643.

Returns:

A string value