org.cloudfoundry.uaa.users

Class Name.Builder

java.lang.Object

org.cloudfoundry.uaa.users.Name.Builder

Enclosing class:

Name

public static final class Name.Builder
extends Object

Builds instances of type Name. 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
Name	build() Builds a new Name.
Name.Builder	familyName(String familyName) Initializes the value for the familyName attribute.
Name.Builder	from(Name instance) Fill a builder with attribute values from the provided Name instance.
Name.Builder	givenName(String givenName) Initializes the value for the givenName attribute.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final Name.Builder from(Name instance)

Fill a builder with attribute values from the provided Name instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

familyName

public final Name.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

givenName

public final Name.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

build

public Name build()

Builds a new Name.

Returns:

An immutable instance of Name

Throws:

IllegalStateException - if any required attributes are missing