org.osiam.resources.scim

Class Email.Builder

java.lang.Object

org.osiam.resources.scim.MultiValuedAttribute.Builder

org.osiam.resources.scim.Email.Builder

Enclosing class:

Email

public static class Email.Builder
extends MultiValuedAttribute.Builder

Builder class that is used to build Email instances

Constructor Summary

Constructors

Constructor and Description
Email.Builder()
Email.Builder(Email email) builds an Builder based of the given Attribute

Method Summary

Methods

Modifier and Type	Method and Description
Email	build() Builds a new Attribute with the given parameters
Email.Builder	setDisplay(String display) Sets the human readable name (See MultiValuedAttribute.getDisplay()).
Email.Builder	setOperation(String operation) Sets the operation (See MultiValuedAttribute.getOperation()).
Email.Builder	setPrimary(boolean primary) Sets the primary attribute (See MultiValuedAttribute.isPrimary()).
Email.Builder	setType(Email.Type type) Sets the label indicating the attribute's function (See MultiValuedAttribute#getType()).
Email.Builder	setValue(String value) Sets the email value.

Methods inherited from class org.osiam.resources.scim.MultiValuedAttribute.Builder

setReference

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Email.Builder

public Email.Builder()

Email.Builder

public Email.Builder(Email email)

builds an Builder based of the given Attribute

Parameters:

email - existing Attribute

Method Detail

setOperation

public Email.Builder setOperation(String operation)

Description copied from class: MultiValuedAttribute.Builder

Sets the operation (See MultiValuedAttribute.getOperation()). Will be automatically set by the UpdateUser

Overrides:

setOperation in class MultiValuedAttribute.Builder

Parameters:

operation - only "delete" is supported at the moment

Returns:

the builder itself

setDisplay

public Email.Builder setDisplay(String display)

Description copied from class: MultiValuedAttribute.Builder

Sets the human readable name (See MultiValuedAttribute.getDisplay()).

client info: the Display value is set by the OSIAM server. If a MultiValuedAttribute which is send to the OSIAM server has this value filled, the value will be ignored or the action will be rejected.

Overrides:

setDisplay in class MultiValuedAttribute.Builder

Parameters:

display - a human readable name

Returns:

the builder itself

setValue

public Email.Builder setValue(String value)

Sets the email value.

Overrides:

setValue in class MultiValuedAttribute.Builder

Parameters:

value - the email attribute

Returns:

the builder itself

Throws:

SCIMDataValidationException - in case the value is not a well-formed email

setType

public Email.Builder setType(Email.Type type)

Sets the label indicating the attribute's function (See MultiValuedAttribute#getType()).

Parameters:

type - the type of the attribute

Returns:

the builder itself

setPrimary

public Email.Builder setPrimary(boolean primary)

Description copied from class: MultiValuedAttribute.Builder

Sets the primary attribute (See MultiValuedAttribute.isPrimary()).

Overrides:

setPrimary in class MultiValuedAttribute.Builder

Returns:

the builder itself

build

public Email build()

Description copied from class: MultiValuedAttribute.Builder

Builds a new Attribute with the given parameters

Specified by:

build in class MultiValuedAttribute.Builder

Returns:

a new MultiValuedAttribute Object