discord4j.common.jackson

Class Possible<T>

java.lang.Object

discord4j.common.jackson.Possible<T>

Type Parameters:

T - JSON Property Type

public class Possible<T>
extends Object

Represents a JSON property that may be absent, but never null if it's present.

Method Summary

Modifier and Type	Method and Description
static <T> Possible<T>	absent() Returns a Possible with an absent value.
boolean	equals(Object o)
T	get() Returns an instance of T if this instance of Possible represents a non-absent value.
int	hashCode()
boolean	isAbsent() Checks whether the instance of this Possible represents an absent value.
static <T> Possible<T>	of(T value) Returns a Possible with a non-null, present value.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

of

public static <T> Possible<T> of(T value)

Returns a Possible with a non-null, present value.

Type Parameters:

T - JSON Property Type

Parameters:

value - A non-null value for a new Possible to represent.

Returns:

An instance of Possible whose value is always present and never null.

Throws:

NullPointerException - If value is null.

absent

public static <T> Possible<T> absent()

Returns a Possible with an absent value.

Type Parameters:

T - JSON Property Type

Returns:

An instance of Possible whose value is absent, but not necessarily null.

get

public T get()

Returns an instance of T if this instance of Possible represents a non-absent value.

Returns:

An instance of T, if it is present. Guaranteed to never be null.

Throws:

NoSuchElementException - If the value is absent.

isAbsent

public boolean isAbsent()

Checks whether the instance of this Possible represents an absent value.

Returns:

True is the value is absent, false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object