Package com.unboundid.scim2.common.types

Class AttributeDefinition

java.lang.Object

com.unboundid.scim2.common.types.AttributeDefinition

public class AttributeDefinition
extends Object

An attribute in a schema for a SCIM Object.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AttributeDefinition.Builder	Builder class to build SCIM2Attributes.
static class	AttributeDefinition.Mutability	This enum is used to describe the mutability of an attribute.
static class	AttributeDefinition.Returned	This enum is used to describe the when an attribute is returned from scim methods.
static class	AttributeDefinition.Type	An enumeration of the data types for values.
static class	AttributeDefinition.Uniqueness

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Collection<String>	getCanonicalValues()	Gets the canonical values of the attribute.
String	getDescription()	Gets the description of the attribute.
AttributeDefinition.Mutability	getMutability()	Gets the mutability constraint for this attribute.
String	getName()	Gets the name of the attribute.
Collection<String>	getReferenceTypes()	Gets the reference types for this attribute.
AttributeDefinition.Returned	getReturned()	Gets the return constraint for this attribute.
Collection<AttributeDefinition>	getSubAttributes()	Gets the subattributes of the attribute.
AttributeDefinition.Type	getType()	Gets the type of the value for this attribute.
AttributeDefinition.Uniqueness	getUniqueness()	Gets the Uniqueness constraint fo this attribute.
int	hashCode()
boolean	isCaseExact()	Is the attribute's value case sensitive.
boolean	isMultiValued()	Determines if the attribute allows multiple values.
boolean	isRequired()	Is the attribute required.
String	toString()	Gets a string representation of the attribute.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

isMultiValued

public boolean isMultiValued()

Determines if the attribute allows multiple values.

Returns:

true if the attribute is multivalues, or false if it is not.

getType

public AttributeDefinition.Type getType()

Gets the type of the value for this attribute.

Returns:

type of the value for this attribute.

isRequired

public boolean isRequired()

Is the attribute required.

Returns:

true if the attribute is required, false if it is not.

isCaseExact

public boolean isCaseExact()

Is the attribute's value case sensitive.

Returns:

true if the attributes value is case sensitive, or false if it is not.

getName

public String getName()

Gets the name of the attribute.

Returns:

the name of the attribute.

getDescription

public String getDescription()

Gets the description of the attribute.

Returns:

the description of the attribute.

getSubAttributes

public Collection<AttributeDefinition> getSubAttributes()

Gets the subattributes of the attribute.

Returns:

the subattributes of the attribute.

getCanonicalValues

public Collection<String> getCanonicalValues()

Gets the canonical values of the attribute.

Returns:

the canonical values of the attribute.

getMutability

public AttributeDefinition.Mutability getMutability()

Gets the mutability constraint for this attribute.

Returns:

the mutability constraint for this attribute.

getReturned

public AttributeDefinition.Returned getReturned()

Gets the return constraint for this attribute.

Returns:

the return constraint for this attribute.

getUniqueness

public AttributeDefinition.Uniqueness getUniqueness()

Gets the Uniqueness constraint fo this attribute.

Returns:

the Uniqueness constraint fo this attribute.

getReferenceTypes

public Collection<String> getReferenceTypes()

Gets the reference types for this attribute.

Returns:

the reference types for this attribute.

toString

public String toString()

Gets a string representation of the attribute.

Overrides:

toString in class Object

Returns:

a string representation of the attribute.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object