Package org.apache.jackrabbit.value

Class ReferenceValue

java.lang.Object

org.apache.jackrabbit.value.BaseValue

org.apache.jackrabbit.value.ReferenceValue

All Implemented Interfaces:

Value

public class ReferenceValue
extends BaseValue

A ReferenceValue provides an implementation of the Value interface representing a REFERENCE value (a UUID of an existing node).

Field Summary

Fields

Modifier and Type	Field	Description
static int	TYPE

Constructor Summary

Constructors

Constructor	Description
ReferenceValue(Node target)	Constructs a ReferenceValue object representing the UUID of an existing node.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)	Indicates whether some other object is "equal to" this one.
boolean	getBoolean()	Returns a Boolean representation of this value.
java.util.Calendar	getDate()	Returns a Calendar representation of this value.
java.math.BigDecimal	getDecimal()	Returns a BigDecimal representation of this value.
double	getDouble()	Returns a double representation of this value.
long	getLong()	Returns a long representation of this value.
int	hashCode()	Returns zero to satisfy the Object equals/hashCode contract.
static ReferenceValue	valueOf(java.lang.String s)	Returns a new ReferenceValue initialized to the value represented by the specified String.

Methods inherited from class org.apache.jackrabbit.value.BaseValue

getBinary, getStream, getString, getType

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE

public static final int TYPE

See Also:

Constant Field Values

Constructor Detail

ReferenceValue

public ReferenceValue(Node target)
               throws RepositoryException

Constructs a ReferenceValue object representing the UUID of an existing node.

Parameters:

target - the node to be referenced

Throws:

java.lang.IllegalArgumentException - If target is nonreferenceable.

RepositoryException - If another error occurs.

Method Detail

valueOf

public static ReferenceValue valueOf(java.lang.String s)
                              throws ValueFormatException

Returns a new ReferenceValue initialized to the value represented by the specified String.

The specified String must denote the UUID of an existing node.

Parameters:

s - the string to be parsed.

Returns:

a newly constructed ReferenceValue representing the the specified value.

Throws:

ValueFormatException - If the String is not a valid not a valid UUID format.

equals

public boolean equals(java.lang.Object obj)

Indicates whether some other object is "equal to" this one.

The result is true if and only if the argument is not null and is a ReferenceValue object that represents the same value as this object.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

hashCode

public int hashCode()

Returns zero to satisfy the Object equals/hashCode contract. This class is mutable and not meant to be used as a hash key.

Overrides:

hashCode in class java.lang.Object

Returns:

always zero

See Also:

Object.hashCode()

getDate

public java.util.Calendar getDate()
                           throws ValueFormatException,
                                  java.lang.IllegalStateException,
                                  RepositoryException

Returns a Calendar representation of this value.

The object returned is a copy of the stored value, so changes to it are not reflected in internal storage.

Specified by:

getDate in interface Value

Overrides:

getDate in class BaseValue

Returns:

A Calendar representation of this value.

Throws:

ValueFormatException - if conversion to a Calendar is not possible.

RepositoryException - if another error occurs.

java.lang.IllegalStateException

getLong

public long getLong()
             throws ValueFormatException,
                    java.lang.IllegalStateException,
                    RepositoryException

Returns a long representation of this value.

Specified by:

getLong in interface Value

Overrides:

getLong in class BaseValue

Returns:

A long representation of this value.

Throws:

ValueFormatException - if conversion to an long is not possible.

RepositoryException - if another error occurs.

java.lang.IllegalStateException

getBoolean

public boolean getBoolean()
                   throws ValueFormatException,
                          java.lang.IllegalStateException,
                          RepositoryException

Returns a Boolean representation of this value.

Specified by:

getBoolean in interface Value

Overrides:

getBoolean in class BaseValue

Returns:

A Boolean representation of this value.

Throws:

ValueFormatException - if conversion to a Boolean is not possible.

RepositoryException - if another error occurs.

java.lang.IllegalStateException

getDouble

public double getDouble()
                 throws ValueFormatException,
                        java.lang.IllegalStateException,
                        RepositoryException

Returns a double representation of this value.

Specified by:

getDouble in interface Value

Overrides:

getDouble in class BaseValue

Returns:

A double representation of this value.

Throws:

ValueFormatException - if conversion to a double is not possible.

RepositoryException - if another error occurs.

java.lang.IllegalStateException

getDecimal

public java.math.BigDecimal getDecimal()
                                throws ValueFormatException,
                                       java.lang.IllegalStateException,
                                       RepositoryException

Returns a BigDecimal representation of this value.

Specified by:

getDecimal in interface Value

Overrides:

getDecimal in class BaseValue

Returns:

A BigDecimal representation of this value.

Throws:

ValueFormatException - if conversion to a BigDecimal is not possible.

RepositoryException - if another error occurs.

java.lang.IllegalStateException