net.pwall.util

Class Ref<T>

java.lang.Object

net.pwall.util.Ref<T>

Type Parameters:

T - Class of the referred-to object

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ComparableRef

public class Ref<T>
extends Object
implements Serializable

A reference to an object.

Author:

Peter Wall

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Ref(T object) Construct a Ref with the given object.

Method Summary

Modifier and Type	Method and Description
static <T> Ref<T>	create(T object) Create a new Ref where the type of the object is inferred from the type of the argument.
static boolean	equal(Object a, Object b) Compare two objects for equality, allowing for nulls.
boolean	equals(Object other) Compare this reference to another for equality.
T	get() Get the object.
T	getObject() Get the object (alternative accessor to allow use of the reference in bean-style accesses).
int	hashCode() Return the hash code for the Ref.
String	toString() Return the String representation of the Ref.

Methods inherited from class java.lang.Object

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

Constructor Detail

Ref

public Ref(T object)

Construct a Ref with the given object.

Parameters:

object - the value for the object

Method Detail

get

public T get()

Get the object.

Returns:

the object

getObject

public T getObject()

Get the object (alternative accessor to allow use of the reference in bean-style accesses).

Returns:

the object

toString

public String toString()

Return the String representation of the Ref. The default representation consists of the representation of the referred-to object enclosed in parentheses.

Overrides:

toString in class Object

Returns:

the string representation

See Also:

Object.toString()

hashCode

public int hashCode()

Return the hash code for the Ref. The default hash code is the hash code of the referred-to object.

Overrides:

hashCode in class Object

Returns:

the hash code

See Also:

Object.hashCode()

equals

public boolean equals(Object other)

Compare this reference to another for equality.

Overrides:

equals in class Object

Parameters:

other - the other reference

Returns:

true if the other object is non-null, is a Ref to a compatible object, and that object is equal to this

See Also:

Object.equals(Object)

equal

public static boolean equal(Object a,
                            Object b)

Compare two objects for equality, allowing for nulls. A null reference always compares unequal to any non-null object, and two nulls are considered equal. This method is public and static so that it may be used as a comparison of two object references even when the Ref class is not used.

Note - this method has been superseded since Java 1.7 by java.util.Objects.equals().

Parameters:

a - the first object

b - the second object

Returns:

true if the first object is equal to the second object

create

public static <T> Ref<T> create(T object)

Create a new Ref where the type of the object is inferred from the type of the argument.

Type Parameters:

T - class of the referred-to object

Parameters:

object - the value for the object

Returns:

the new Ref