org.opendaylight.yangtools.concepts

Class Variant<T,U>

java.lang.Object

org.opendaylight.yangtools.concepts.Variant<T,U>

Type Parameters:

T - First alternative type

U - Second alternative type

Direct Known Subclasses:

CheckedValue

@Beta
 @NonNullByDefault
 @ThreadSafe
public class Variant<T,U>
extends Object

Utility holder of a two-variant value. The class design treats both variants as equal.

Author:

Robert Varga

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Variant(T first)
protected	Variant(U second, @Nullable Void dummy)

Method Summary

Modifier and Type	Method and Description
protected com.google.common.base.MoreObjects.ToStringHelper	addToString(com.google.common.base.MoreObjects.ToStringHelper helper)
boolean	equals(@Nullable Object obj)
protected T	first()
T	getFirst()
U	getSecond()
int	hashCode()
boolean	isFirst()
boolean	isSecond()
static <T,U> Variant<T,U>	ofFirst(T value) Create a new instance containing specified value.
static <T,U> Variant<T,U>	ofSecond(U value) Create a new instance containing specified value.
protected U	second()
String	toString()
Optional<T>	tryFirst()
Optional<U>	trySecond()

Methods inherited from class java.lang.Object

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

Constructor Detail

Variant

protected Variant(T first)

Variant

protected Variant(U second,
                  @Nullable Void dummy)

Method Detail

first

protected final T first()

second

protected final U second()

ofFirst

public static <T,U> Variant<T,U> ofFirst(T value)

Create a new instance containing specified value.

Type Parameters:

T - First alternative type

U - Second alternative type

Parameters:

value - Value

Returns:

A new instance

Throws:

NullPointerException - if value is null

ofSecond

public static <T,U> Variant<T,U> ofSecond(U value)

Create a new instance containing specified value.

Type Parameters:

T - First alternative type

U - Second alternative type

Parameters:

value - Value

Returns:

A new instance

Throws:

NullPointerException - if value is null

isFirst

public final boolean isFirst()

getFirst

public final T getFirst()

tryFirst

public final Optional<T> tryFirst()

isSecond

public final boolean isSecond()

getSecond

public final U getSecond()

trySecond

public final Optional<U> trySecond()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(@Nullable Object obj)

Overrides:

equals in class Object

toString

public final String toString()

Overrides:

toString in class Object

addToString

protected com.google.common.base.MoreObjects.ToStringHelper addToString(com.google.common.base.MoreObjects.ToStringHelper helper)