Package com.unboundid.scim2.common.annotations

Annotation Type Attribute

@Retention(RUNTIME)
@Target(FIELD)
public @interface Attribute

Annotation for getter methods of a SCIM object.

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	description	The description of the attribute.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String[]	canonicalValues	The canonical values that may appear in an attribute.
boolean	isCaseExact	Determines if the attribute value is case-sensitive.
boolean	isRequired	Determines if the attribute value is required.
Class	multiValueClass	If the attribute is multi-value, this holds the type of the child object.
AttributeDefinition.Mutability	mutability	The mutability constraint for the attribute.
String[]	referenceTypes	The reference types for the attribute.
AttributeDefinition.Returned	returned	The return constraint for the attribute.
AttributeDefinition.Uniqueness	uniqueness	The uniqueness constraint for the attribute.

Element Detail

description

String description

The description of the attribute.

Returns:

The description of the attribute.

isCaseExact

boolean isCaseExact

Determines if the attribute value is case-sensitive.

Returns:

A flag indicating the attribute value's case sensitivity.

Default:

true

isRequired

boolean isRequired

Determines if the attribute value is required.

Returns:

A flag indicating if the attribute value is required.

Default:

false

canonicalValues

String[] canonicalValues

The canonical values that may appear in an attribute.

Returns:

The canonical values that may appear in an attribute.

Default:

{}

returned

AttributeDefinition.Returned returned

The return constraint for the attribute.

Returns:

The return constraint for the attribute.

Default:

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

uniqueness

AttributeDefinition.Uniqueness uniqueness

The uniqueness constraint for the attribute.

Returns:

The uniqueness constraint for the attribute.

Default:

com.unboundid.scim2.common.types.AttributeDefinition.Uniqueness.NONE

referenceTypes

String[] referenceTypes

The reference types for the attribute.

Returns:

The reference types for the attribute.

Default:

{}

mutability

AttributeDefinition.Mutability mutability

The mutability constraint for the attribute.

Returns:

The mutability constraint for the attribute.

Default:

com.unboundid.scim2.common.types.AttributeDefinition.Mutability.READ_WRITE

multiValueClass

Class multiValueClass

If the attribute is multi-value, this holds the type of the child object.

Returns:

For a multi-valued attribute, the type of the child object.

Default:

javax.lang.model.type.NullType.class