com.atlassian.idp.model

Class ImmutableScimName

java.lang.Object

com.atlassian.idp.model.ScimName

com.atlassian.idp.model.ImmutableScimName

@ParametersAreNonnullByDefault
 @Generated(value={"Immutables.generator","ScimName"})
 @Immutable
public final class ImmutableScimName
extends ScimName

Immutable implementation of ScimName.

Use the builder to create immutable instances: ImmutableScimName.builder(). Use the static factory method to create immutable instances: ImmutableScimName.of().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableScimName.Builder Builds instances of type ImmutableScimName.

Method Summary

Modifier and Type	Method and Description
static ImmutableScimName.Builder	builder() Creates a builder for ImmutableScimName.
static ImmutableScimName	copyOf(ScimName instance) Creates an immutable copy of a ScimName value.
boolean	equals(Object another) This instance is equal to all instances of ImmutableScimName that have equal attribute values.
String	getFamilyName()
String	getFormattedName()
String	getGivenName()
int	hashCode() Computes a hash code from attributes: familyName, givenName, formattedName.
static ImmutableScimName	of(String familyName, String givenName, String formattedName) Construct a new immutable ScimName instance.
String	toString() Prints the immutable value ScimName with attribute values.
ImmutableScimName	withFamilyName(String value) Copy the current immutable object by setting a value for the familyName attribute.
ImmutableScimName	withFormattedName(String value) Copy the current immutable object by setting a value for the formattedName attribute.
ImmutableScimName	withGivenName(String value) Copy the current immutable object by setting a value for the givenName attribute.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getFamilyName

@Nullable
public String getFamilyName()

Specified by:

getFamilyName in class ScimName

Returns:

The value of the familyName attribute

getGivenName

@Nullable
public String getGivenName()

Specified by:

getGivenName in class ScimName

Returns:

The value of the givenName attribute

getFormattedName

@Nullable
public String getFormattedName()

Specified by:

getFormattedName in class ScimName

Returns:

The value of the formattedName attribute

withFamilyName

public final ImmutableScimName withFamilyName(@Nullable
                                              String value)

Copy the current immutable object by setting a value for the familyName attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for familyName (can be null)

Returns:

A modified copy of the this object

withGivenName

public final ImmutableScimName withGivenName(@Nullable
                                             String value)

Copy the current immutable object by setting a value for the givenName attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for givenName (can be null)

Returns:

A modified copy of the this object

withFormattedName

public final ImmutableScimName withFormattedName(@Nullable
                                                 String value)

Copy the current immutable object by setting a value for the formattedName attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for formattedName (can be null)

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableScimName that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: familyName, givenName, formattedName.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value ScimName with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static ImmutableScimName of(@Nullable
                                   String familyName,
                                   @Nullable
                                   String givenName,
                                   @Nullable
                                   String formattedName)

Construct a new immutable ScimName instance.

Parameters:

familyName - The value for the familyName attribute

givenName - The value for the givenName attribute

formattedName - The value for the formattedName attribute

Returns:

An immutable ScimName instance

copyOf

public static ImmutableScimName copyOf(ScimName instance)

Creates an immutable copy of a ScimName value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Parameters:

instance - The instance to copy

Returns:

A copied immutable ScimName instance

builder

public static ImmutableScimName.Builder builder()

Creates a builder for ImmutableScimName.

Returns:

A new ImmutableScimName builder