org.cloudfoundry.uaa.users

Class Invite.Builder

java.lang.Object

org.cloudfoundry.uaa.users.Invite.Builder

Enclosing class:

Invite

public static final class Invite.Builder
extends Object

Builds instances of type Invite. 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
Invite	build() Builds a new Invite.
Invite.Builder	email(String email) Initializes the value for the email attribute.
Invite.Builder	errorCode(String errorCode) Initializes the value for the errorCode attribute.
Invite.Builder	errorMessage(String errorMessage) Initializes the value for the errorMessage attribute.
Invite.Builder	from(Invite instance) Fill a builder with attribute values from the provided Invite instance.
Invite.Builder	inviteLink(String inviteLink) Initializes the value for the inviteLink attribute.
Invite.Builder	origin(String origin) Initializes the value for the origin attribute.
Invite.Builder	success(Boolean success) Initializes the value for the success attribute.
Invite.Builder	userId(String userId) Initializes the value for the userId attribute.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final Invite.Builder from(Invite instance)

Fill a builder with attribute values from the provided Invite 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

email

public final Invite.Builder email(String email)

Initializes the value for the email attribute.

Parameters:

email - The value for email

Returns:

this builder for use in a chained invocation

errorCode

public final Invite.Builder errorCode(String errorCode)

Initializes the value for the errorCode attribute.

Parameters:

errorCode - The value for errorCode (can be null)

Returns:

this builder for use in a chained invocation

errorMessage

public final Invite.Builder errorMessage(String errorMessage)

Initializes the value for the errorMessage attribute.

Parameters:

errorMessage - The value for errorMessage (can be null)

Returns:

this builder for use in a chained invocation

inviteLink

public final Invite.Builder inviteLink(String inviteLink)

Initializes the value for the inviteLink attribute.

Parameters:

inviteLink - The value for inviteLink (can be null)

Returns:

this builder for use in a chained invocation

origin

public final Invite.Builder origin(String origin)

Initializes the value for the origin attribute.

Parameters:

origin - The value for origin (can be null)

Returns:

this builder for use in a chained invocation

success

public final Invite.Builder success(Boolean success)

Initializes the value for the success attribute.

Parameters:

success - The value for success

Returns:

this builder for use in a chained invocation

userId

public final Invite.Builder userId(String userId)

Initializes the value for the userId attribute.

Parameters:

userId - The value for userId (can be null)

Returns:

this builder for use in a chained invocation

build

public Invite build()

Builds a new Invite.

Returns:

An immutable instance of Invite

Throws:

IllegalStateException - if any required attributes are missing