Package com.telenordigital.nbiot

Class ImmutableCollection

java.lang.Object

com.telenordigital.nbiot.ImmutableCollection

All Implemented Interfaces:

Collection

@ParametersAreNonnullByDefault
@Immutable
public final class ImmutableCollection
extends Object
implements Collection

Immutable implementation of Collection.

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface com.telenordigital.nbiot.Collection

Collection.CollectionList

Method Summary

Modifier and Type	Method	Description
static ImmutableCollection	copyOf(Collection instance)	Creates an immutable copy of a Collection value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableCollection that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: id, teamID, tags.
String	id()	The collection's ID
Map<String,String>	tags()	Collection tags.
String	teamID()	The team's ID
String	toString()	Prints the immutable value Collection with attribute values.
ImmutableCollection	withId(String value)	Copy the current immutable object by setting a value for the id attribute.
ImmutableCollection	withTags(Map<String,? extends String> entries)	Copy the current immutable object by replacing the tags map with the specified map.
ImmutableCollection	withTeamID(String value)	Copy the current immutable object by setting a value for the teamID attribute.

Methods inherited from class java.lang.Object

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

Method Detail

id

@Nullable
public String id()

The collection's ID

Specified by:

id in interface Collection

teamID

@Nullable
public String teamID()

The team's ID

Specified by:

teamID in interface Collection

tags

@Nullable
public Map<String,String> tags()

Collection tags.

Specified by:

tags in interface Collection

withId

public final ImmutableCollection withId(@Nullable
                                        String value)

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

Parameters:

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

Returns:

A modified copy of the this object

withTeamID

public final ImmutableCollection withTeamID(@Nullable
                                            String value)

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

Parameters:

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

Returns:

A modified copy of the this object

withTags

public final ImmutableCollection withTags(@Nullable
                                          Map<String,? extends String> entries)

Copy the current immutable object by replacing the tags map with the specified map. Nulls are not permitted as keys or values. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

entries - The entries to be added to the tags map

Returns:

A modified copy of this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableCollection 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: id, teamID, tags.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Collection with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableCollection copyOf(Collection instance)

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