Package net.tangly.commons.lang

Class Reference<T>

java.lang.Object

net.tangly.commons.lang.Reference<T>

Type Parameters:

T - type of the reference

public class Reference<T>
extends Object

A reference to an object, emulating the concept of typed pointer to typed variable. The indirection can be updated to emulate indirection such as pointer to pointer in other languages.

Constructor Summary

Constructors

Constructor	Description
Reference()	Constructor of the class to build an empty reference.
Reference(T reference)	Constructor of the class.

Method Summary

Modifier and Type	Method	Description
static <T> Reference<T>	empty()	Return a new empty reference to the given object.
T	get()	Return the reference object.
void	ifPresent(@NotNull Consumer<? super T> action)	If a value is present, performs the given action with the value, otherwise does nothing.
boolean	isEmpty()	If a value is not present, returns true, otherwise false.
boolean	isPresent()	If a value is present, returns true, otherwise false.
static <T> Reference<T>	of(T reference)	Return a new reference to the given object.
void	set(T reference)	Set the referenced object.

Methods inherited from class java.lang.Object

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

Constructor Details

Reference

public Reference(T reference)

Constructor of the class.

Parameters:

reference - reference object

Reference

public Reference()

Constructor of the class to build an empty reference.

Method Details

of

public static <T> Reference<T> of(T reference)

Return a new reference to the given object.

Type Parameters:

T - type of the reference

Parameters:

reference - referenced object

Returns:

new reference

empty

public static <T> Reference<T> empty()

Return a new empty reference to the given object.

Type Parameters:

T - type of the reference

Returns:

new empty reference

set

public void set(T reference)

Set the referenced object.

Parameters:

reference - referenced object

See Also:

• get()

get

public T get()

Return the reference object.

Returns:

referenced object

See Also:

• set(Object)

isEmpty

public boolean isEmpty()

If a value is not present, returns true, otherwise false.

Returns:

true if a value is not present, otherwise false

isPresent

public boolean isPresent()

If a value is present, returns true, otherwise false.

Returns:

true if a value is present, otherwise false

ifPresent

public void ifPresent(@NotNull
 @NotNull Consumer<? super T> action)

If a value is present, performs the given action with the value, otherwise does nothing.

Parameters:

action - the action to be performed, if a value is present