com.atlassian.idp.model

Class ImmutableScimName.Builder

java.lang.Object

com.atlassian.idp.model.ImmutableScimName.Builder

Enclosing class:

ImmutableScimName

@NotThreadSafe
public static final class ImmutableScimName.Builder
extends Object

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

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

withFamilyName

public final ImmutableScimName.Builder withFamilyName(@Nullable
                                                      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

withGivenName

public final ImmutableScimName.Builder withGivenName(@Nullable
                                                     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

withFormattedName

public final ImmutableScimName.Builder withFormattedName(@Nullable
                                                         String formattedName)

Initializes the value for the formattedName attribute.

Parameters:

formattedName - The value for formattedName (can be null)

Returns:

this builder for use in a chained invocation

build

public ImmutableScimName build()

Builds a new ImmutableScimName.

Returns:

An immutable instance of ScimName

Throws:

IllegalStateException - if any required attributes are missing