org.osiam.resources.scim

Class Extension

java.lang.Object

org.osiam.resources.scim.Extension

public class Extension
extends Object

This class represents a schema extension.

For more detailed information please look at the SCIM core schema 2.0, section 4

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Extension.Builder Builder class that is used to build Extension instances
static class	Extension.Field This class represents a field of an extension with its type and value.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Extension() Default constructor for Jackson

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
<T> T	getField(String field, ExtensionFieldType<T> extensionFieldType) Return the value for the field with a given name and type.
boolean	getFieldAsBoolean(String field) Return the value for the field with a given name as boolean.
ByteBuffer	getFieldAsByteBuffer(String field) Return the value for the field with a given name as ByteBuffer.
Date	getFieldAsDate(String field) Return the value for the field with a given name as Date.
BigDecimal	getFieldAsDecimal(String field) Return the value for the field with a given name as BigDecimal.
BigInteger	getFieldAsInteger(String field) Return the value for the field with a given name as BigInteger.
URI	getFieldAsReference(String field) Return the value for the field with a given name as URI.
String	getFieldAsString(String field) Return the value for the field with a given name as String.
Map<String,Extension.Field>	getFields() Provides a Map containing the entries of the extension.
String	getUrn() Returns the URN of this extension.
int	hashCode()
boolean	isFieldPresent(String field) Checks if the given field is present in this extension because not every field is mandatory (according to scim 2.0 spec).
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Extension

protected Extension()

Default constructor for Jackson

Method Detail

getUrn

public String getUrn()

Returns the URN of this extension.

Returns:

The URN

getField

public <T> T getField(String field,
             ExtensionFieldType<T> extensionFieldType)

Return the value for the field with a given name and type.

Parameters:

field - The name of the field to retrieve the value of.

extensionFieldType - The type of the field.

Returns:

The value for the field with the given name.

Throws:

NoSuchElementException - if this schema does not contain a field of the given name.

IllegalArgumentException - if the given field is null or an empty string or if the extensionFieldType is null.

getFieldAsString

public String getFieldAsString(String field)

Return the value for the field with a given name as String.

Parameters:

field - The name of the field to retrieve the value of.

Returns:

The value for the field with the given name.

Throws:

NoSuchElementException - if this schema does not contain a field of the given name.

IllegalArgumentException - if the given field is null or an empty string or if the extensionFieldType is null.

getFieldAsBoolean

public boolean getFieldAsBoolean(String field)

Return the value for the field with a given name as boolean.

Parameters:

field - The name of the field to retrieve the value of.

Returns:

The value for the field with the given name.

Throws:

NoSuchElementException - if this schema does not contain a field of the given name.

IllegalArgumentException - if the given field is null or an empty string or if the extensionFieldType is null.

getFieldAsByteBuffer

public ByteBuffer getFieldAsByteBuffer(String field)

Return the value for the field with a given name as ByteBuffer.

Parameters:

field - The name of the field to retrieve the value of.

Returns:

The value for the field with the given name.

Throws:

NoSuchElementException - if this schema does not contain a field of the given name.

IllegalArgumentException - if the given field is null or an empty string or if the extensionFieldType is null.

getFieldAsDate

public Date getFieldAsDate(String field)

Return the value for the field with a given name as Date.

Parameters:

field - The name of the field to retrieve the value of.

Returns:

The value for the field with the given name.

Throws:

NoSuchElementException - if this schema does not contain a field of the given name.

IllegalArgumentException - if the given field is null or an empty string or if the extensionFieldType is null.

getFieldAsDecimal

public BigDecimal getFieldAsDecimal(String field)

Return the value for the field with a given name as BigDecimal.

Parameters:

field - The name of the field to retrieve the value of.

Returns:

The value for the field with the given name.

Throws:

NoSuchElementException - if this schema does not contain a field of the given name.

IllegalArgumentException - if the given field is null or an empty string or if the extensionFieldType is null.

getFieldAsInteger

public BigInteger getFieldAsInteger(String field)

Return the value for the field with a given name as BigInteger.

Parameters:

field - The name of the field to retrieve the value of.

Returns:

The value for the field with the given name.

Throws:

NoSuchElementException - if this schema does not contain a field of the given name.

IllegalArgumentException - if the given field is null or an empty string or if the extensionFieldType is null.

getFieldAsReference

public URI getFieldAsReference(String field)

Return the value for the field with a given name as URI.

Parameters:

field - The name of the field to retrieve the value of.

Returns:

The value for the field with the given name.

Throws:

NoSuchElementException - if this schema does not contain a field of the given name.

IllegalArgumentException - if the given field is null or an empty string or if the extensionFieldType is null.

getFields

public Map<String,Extension.Field> getFields()

Provides a Map containing the entries of the extension. Note that the returned Map is immutable.

Returns:

The Entries of this schema as an map.

isFieldPresent

public boolean isFieldPresent(String field)

Checks if the given field is present in this extension because not every field is mandatory (according to scim 2.0 spec).

Parameters:

field - Name of the field to check

Returns:

true if the given field is present, else false

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object