com.clxcommunications.xms

Class UpdateValue<T>

java.lang.Object

com.clxcommunications.xms.UpdateValue<T>

Type Parameters:

T - the wrapped type

@Value.Immutable
public abstract class UpdateValue<T>
extends Object

Wrapper class for API objects used for update API methods. Allows

Constructor Summary

Constructors

Constructor and Description
UpdateValue()

Method Summary

Modifier and Type	Method and Description
boolean	isSet() Whether this update value is set or unset.
static <T> UpdateValue<T>	set(T value) An update value indicating that the value should be changed.
String	toString()
static <T> UpdateValue<T>	unset() An update value indicating that the value should be reset to its default value.
abstract T	valueOrNull() Returns the update value or null if unset.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateValue

public UpdateValue()

Method Detail

unset

@Nonnull
public static <T> UpdateValue<T> unset()

An update value indicating that the value should be reset to its default value.

Type Parameters:

T - the wrapped type

Returns:

an update indicating a reset

set

@Nonnull
public static <T> UpdateValue<T> set(@Nullable
                                              T value)

An update value indicating that the value should be changed. Note, setting a null value is equivalent to using unset().

Type Parameters:

T - the wrapped type

Parameters:

value - the new value

Returns:

an update indicating a set

valueOrNull

@Nullable
public abstract T valueOrNull()

Returns the update value or null if unset.

Returns:

the update value if set, null otherwise

isSet

public final boolean isSet()

Whether this update value is set or unset.

Returns:

true if set; false otherwise

toString

public String toString()

Overrides:

toString in class Object