Package com.telenordigital.nbiot

Class ImmutableOutput

java.lang.Object

com.telenordigital.nbiot.ImmutableOutput

All Implemented Interfaces:

Output

@ParametersAreNonnullByDefault
@Immutable
public final class ImmutableOutput
extends Object
implements Output

Immutable implementation of Output.

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

Nested Class Summary

Nested Classes

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

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

Output.OutputList

Method Summary

Modifier and Type	Method	Description
String	collectionID()	The collection the output belongs to.
Map<String,Object>	config()	The type-specific configuration.
static ImmutableOutput	copyOf(Output instance)	Creates an immutable copy of a Output value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableOutput that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: id, collectionID, type, config.
String	id()	The output's ID.
String	toString()	Prints the immutable value Output with attribute values.
String	type()	The output's type.
ImmutableOutput	withCollectionID(String value)	Copy the current immutable object by setting a value for the collectionID attribute.
ImmutableOutput	withConfig(Map<String,? extends Object> entries)	Copy the current immutable object by replacing the config map with the specified map.
ImmutableOutput	withId(String value)	Copy the current immutable object by setting a value for the id attribute.
ImmutableOutput	withType(String value)	Copy the current immutable object by setting a value for the type attribute.

Methods inherited from class java.lang.Object

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

Method Detail

id

@Nullable
public String id()

The output's ID.

Specified by:

id in interface Output

collectionID

@Nullable
public String collectionID()

The collection the output belongs to.

Specified by:

collectionID in interface Output

type

@Nullable
public String type()

The output's type.

Specified by:

type in interface Output

config

@Nullable
public Map<String,Object> config()

The type-specific configuration.

Specified by:

config in interface Output

withId

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

withType

public final ImmutableOutput withType(@Nullable
                                      String value)

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

Parameters:

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

Returns:

A modified copy of the this object

withConfig

public final ImmutableOutput withConfig(@Nullable
                                        Map<String,? extends Object> entries)

Copy the current immutable object by replacing the config 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 config map

Returns:

A modified copy of this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableOutput 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, type, config.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Output with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableOutput copyOf(Output instance)

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