Class ImmutableUaaUser.Name

  • All Implemented Interfaces:
    UaaUser.Name
    Enclosing class:
    ImmutableUaaUser

    @Immutable
    public static final class ImmutableUaaUser.Name
    extends Object
    implements UaaUser.Name
    Immutable implementation of UaaUser.Name.

    Use the builder to create immutable instances: ImmutableUaaUser.Name.builder().

    • Method Detail

      • withFamilyName

        public final ImmutableUaaUser.Name withFamilyName​(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 ImmutableUaaUser.Name withGivenName​(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
      • equals

        public boolean equals​(@Nullable
                              Object another)
        This instance is equal to all instances of Name 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.
        Overrides:
        hashCode in class Object
        Returns:
        hashCode value
      • toString

        public String toString()
        Prints the immutable value Name with attribute values.
        Overrides:
        toString in class Object
        Returns:
        A string representation of the value
      • copyOf

        public static ImmutableUaaUser.Name copyOf​(UaaUser.Name instance)
        Creates an immutable copy of a UaaUser.Name 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 Name instance
      • builder

        public static ImmutableUaaUser.Name.Builder builder()
        Creates a builder for Name.
         ImmutableUaaUser.Name.builder()
            .familyName(String | null) // nullable familyName
            .givenName(String | null) // nullable givenName
            .build();
         
        Returns:
        A new Name builder