Package com.telenordigital.nbiot

Class ImmutableDataSearchParameters

java.lang.Object

com.telenordigital.nbiot.ImmutableDataSearchParameters

All Implemented Interfaces:

DataSearchParameters

@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
public final class ImmutableDataSearchParameters
extends Object
implements DataSearchParameters

Immutable implementation of DataSearchParameters.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ImmutableDataSearchParameters	copyOf(DataSearchParameters instance)	Creates an immutable copy of a DataSearchParameters value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableDataSearchParameters that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: limit, since, until.
Integer	limit()	Limit number of results when querying data endpoint
Instant	since()	Fetch data since given Instant
String	toString()	Prints the immutable value DataSearchParameters with attribute values.
Instant	until()	Fetch data until given Instant
ImmutableDataSearchParameters	withLimit(Integer value)	Copy the current immutable object by setting a value for the limit attribute.
ImmutableDataSearchParameters	withSince(Instant value)	Copy the current immutable object by setting a value for the since attribute.
ImmutableDataSearchParameters	withUntil(Instant value)	Copy the current immutable object by setting a value for the until attribute.

Methods inherited from class java.lang.Object

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

Method Detail

limit

@Nullable
public Integer limit()

Limit number of results when querying data endpoint

Specified by:

limit in interface DataSearchParameters

Returns:

Limit parameter as an Integer

since

@Nullable
public Instant since()

Fetch data since given Instant

Specified by:

since in interface DataSearchParameters

Returns:

Since parameter as Instant

until

@Nullable
public Instant until()

Fetch data until given Instant

Specified by:

until in interface DataSearchParameters

Returns:

Until parameter as Instant

withLimit

public final ImmutableDataSearchParameters withLimit(@Nullable
                                                     Integer value)

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

Parameters:

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

Returns:

A modified copy of the this object

withSince

public final ImmutableDataSearchParameters withSince(@Nullable
                                                     Instant value)

Copy the current immutable object by setting a value for the since attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

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

Returns:

A modified copy of the this object

withUntil

public final ImmutableDataSearchParameters withUntil(@Nullable
                                                     Instant value)

Copy the current immutable object by setting a value for the until attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for until (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 ImmutableDataSearchParameters 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: limit, since, until.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value DataSearchParameters with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableDataSearchParameters copyOf(DataSearchParameters instance)

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