Package com.telenordigital.nbiot

Class ImmutableDevice

java.lang.Object

com.telenordigital.nbiot.ImmutableDevice

All Implemented Interfaces:

Device

@ParametersAreNonnullByDefault
@Immutable
public final class ImmutableDevice
extends Object
implements Device

Immutable implementation of Device.

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

Nested Class Summary

Nested Classes

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

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

Device.DeviceList

Method Summary

Modifier and Type	Method	Description
String	collectionID()	The collection the device belongs to.
static ImmutableDevice	copyOf(Device instance)	Creates an immutable copy of a Device value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableDevice that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: id, collectionID, imei, imsi, tags.
String	id()	The device's EUI.
String	imei()	The device's IMEI.
String	imsi()	The device's IMSI.
Map<String,String>	tags()
String	toString()	Prints the immutable value Device with attribute values.
ImmutableDevice	withCollectionID(String value)	Copy the current immutable object by setting a value for the collectionID attribute.
ImmutableDevice	withId(String value)	Copy the current immutable object by setting a value for the id attribute.
ImmutableDevice	withImei(String value)	Copy the current immutable object by setting a value for the imei attribute.
ImmutableDevice	withImsi(String value)	Copy the current immutable object by setting a value for the imsi attribute.
ImmutableDevice	withTags(Map<String,? extends String> entries)	Copy the current immutable object by replacing the tags map with the specified map.

Methods inherited from class java.lang.Object

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

Method Detail

id

@Nullable
public String id()

The device's EUI.

Specified by:

id in interface Device

collectionID

@Nullable
public String collectionID()

The collection the device belongs to.

Specified by:

collectionID in interface Device

imei

@Nullable
public String imei()

The device's IMEI.

Specified by:

imei in interface Device

imsi

@Nullable
public String imsi()

The device's IMSI.

Specified by:

imsi in interface Device

tags

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

Specified by:

tags in interface Device

Returns:

The value of the tags attribute

withId

public final ImmutableDevice 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

withCollectionID

public final ImmutableDevice withCollectionID(@Nullable
                                              String value)

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

Parameters:

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

Returns:

A modified copy of the this object

withImei

public final ImmutableDevice withImei(@Nullable
                                      String value)

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

Parameters:

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

Returns:

A modified copy of the this object

withImsi

public final ImmutableDevice withImsi(@Nullable
                                      String value)

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

Parameters:

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

Returns:

A modified copy of the this object

withTags

public final ImmutableDevice 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 ImmutableDevice 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, collectionID, imei, imsi, tags.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Device with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableDevice copyOf(Device instance)

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