Package com.telenordigital.nbiot

Class ImmutableMember

java.lang.Object

com.telenordigital.nbiot.ImmutableMember

All Implemented Interfaces:

Member

@ParametersAreNonnullByDefault
@Immutable
public final class ImmutableMember
extends Object
implements Member

Immutable implementation of Member.

Use the builder to create immutable instances: new ImmutableMember.Builder().

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ImmutableMember	copyOf(Member instance)	Creates an immutable copy of a Member value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableMember that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: userID, role.
String	role()	The user's role
String	toString()	Prints the immutable value Member with attribute values.
String	userID()	The user's ID
ImmutableMember	withRole(String value)	Copy the current immutable object by setting a value for the role attribute.
ImmutableMember	withUserID(String value)	Copy the current immutable object by setting a value for the userID attribute.

Methods inherited from class java.lang.Object

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

Method Detail

userID

@Nullable
public String userID()

The user's ID

Specified by:

userID in interface Member

role

@Nullable
public String role()

The user's role

Specified by:

role in interface Member

withUserID

public final ImmutableMember withUserID(@Nullable
                                        String value)

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

Parameters:

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

Returns:

A modified copy of the this object

withRole

public final ImmutableMember withRole(@Nullable
                                      String value)

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

Parameters:

value - A new value for role (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 ImmutableMember 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: userID, role.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Member with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableMember copyOf(Member instance)

Creates an immutable copy of a Member 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 Member instance