org.mule.runtime.api.util

Class Reference<T>

java.lang.Object

org.mule.runtime.api.util.Reference<T>

Type Parameters:

T - the generic type of the referenced value

public class Reference<T>
extends Object

An object which holds a reference to a given value.

Because this class represents a reference to such value instead of just being a simple holder, the equals(Object) has been redefined to test that the two values are actually the same ('=='). Consistently, the hashCode() method is defined to return the value's identity hash code.

The above makes this class useful for cases in which you need to build a set of unique references, without depending on the actual equals(Object) and hashCode() implementations.

null references are also supported.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
Reference() Creates a new instance which references null
Reference(T value) Creates a new instance

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
T	get()
int	hashCode()
T	set(T value)

Methods inherited from class java.lang.Object

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

Constructor Detail

Reference

public Reference()

Creates a new instance which references null

Reference

public Reference(T value)

Creates a new instance

Parameters:

value - the referenced value

Method Detail

get

public T get()

Returns:

the referenced value

set

public T set(T value)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

Parameters:

obj - the compared object

Returns:

true if obj is a Reference which references the same value

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Returns:

the value's hash code