org.cloudfoundry.uaa.identityproviders

Class AttributeMappings.Builder

java.lang.Object

org.cloudfoundry.uaa.identityproviders.AttributeMappings.Builder

Enclosing class:

AttributeMappings

public static final class AttributeMappings.Builder
extends Object

Builds instances of type AttributeMappings. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method and Description
AttributeMappings.Builder	addAllExternalGroups(Iterable<String> elements) Adds elements to externalGroups list.
AttributeMappings	build() Builds a new AttributeMappings.
AttributeMappings.Builder	email(String email) Initializes the value for the email attribute.
AttributeMappings.Builder	externalGroup(String element) Adds one element to externalGroups list.
AttributeMappings.Builder	externalGroups(Iterable<String> elements) Sets or replaces all elements for externalGroups list.
AttributeMappings.Builder	externalGroups(String... elements) Adds elements to externalGroups list.
AttributeMappings.Builder	familyName(String familyName) Initializes the value for the familyName attribute.
AttributeMappings.Builder	firstName(String firstName) Initializes the value for the firstName attribute.
AttributeMappings.Builder	from(AttributeMappings instance) Fill a builder with attribute values from the provided AttributeMappings instance.
AttributeMappings.Builder	givenName(String givenName) Initializes the value for the givenName attribute.
AttributeMappings.Builder	phoneNumber(String phoneNumber) Initializes the value for the phoneNumber attribute.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final AttributeMappings.Builder from(AttributeMappings instance)

Fill a builder with attribute values from the provided AttributeMappings instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values. Collection elements and entries will be added, not replaced.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

email

public final AttributeMappings.Builder email(String email)

Initializes the value for the email attribute.

Parameters:

email - The value for email (can be null)

Returns:

this builder for use in a chained invocation

externalGroup

public final AttributeMappings.Builder externalGroup(String element)

Adds one element to externalGroups list.

Parameters:

element - A externalGroups element

Returns:

this builder for use in a chained invocation

externalGroups

public final AttributeMappings.Builder externalGroups(String... elements)

Adds elements to externalGroups list.

Parameters:

elements - An array of externalGroups elements

Returns:

this builder for use in a chained invocation

externalGroups

public final AttributeMappings.Builder externalGroups(Iterable<String> elements)

Sets or replaces all elements for externalGroups list.

Parameters:

elements - An iterable of externalGroups elements

Returns:

this builder for use in a chained invocation

addAllExternalGroups

public final AttributeMappings.Builder addAllExternalGroups(Iterable<String> elements)

Adds elements to externalGroups list.

Parameters:

elements - An iterable of externalGroups elements

Returns:

this builder for use in a chained invocation

familyName

public final AttributeMappings.Builder familyName(String familyName)

Initializes the value for the familyName attribute.

Parameters:

familyName - The value for familyName (can be null)

Returns:

this builder for use in a chained invocation

firstName

public final AttributeMappings.Builder firstName(String firstName)

Initializes the value for the firstName attribute.

Parameters:

firstName - The value for firstName (can be null)

Returns:

this builder for use in a chained invocation

givenName

public final AttributeMappings.Builder givenName(String givenName)

Initializes the value for the givenName attribute.

Parameters:

givenName - The value for givenName (can be null)

Returns:

this builder for use in a chained invocation

phoneNumber

public final AttributeMappings.Builder phoneNumber(String phoneNumber)

Initializes the value for the phoneNumber attribute.

Parameters:

phoneNumber - The value for phoneNumber (can be null)

Returns:

this builder for use in a chained invocation

build

public AttributeMappings build()

Builds a new AttributeMappings.

Returns:

An immutable instance of AttributeMappings

Throws:

IllegalStateException - if any required attributes are missing