org.apache.jackrabbit.value
Class ReferenceValue

java.lang.Object
  org.apache.jackrabbit.value.BaseValue
      org.apache.jackrabbit.value.ReferenceValue

All Implemented Interfaces:

javax.jcr.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

static int

TYPE

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

DEFAULT_ENCODING, stream, type

Constructor Summary

	ReferenceValue(javax.jcr.Node target) Constructs a ReferenceValue object representing the UUID of an existing node.
protected	ReferenceValue(java.lang.String uuid) Protected constructor creating a ReferenceValue object without validating the UUID format.

Method Summary

boolean	equals(java.lang.Object obj) Indicates whether some other object is "equal to" this one.
boolean	getBoolean()
java.util.Calendar	getDate()
double	getDouble()
protected java.lang.String	getInternalString() Returns the internal string representation of this value without modifying the value state.
long	getLong()
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

getStream, getString, getType, setStreamConsumed, setValueConsumed

Methods inherited from class java.lang.Object

clone, finalize, 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(javax.jcr.Node target)
               throws javax.jcr.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.

javax.jcr.RepositoryException - If another error occurs.

ReferenceValue

protected ReferenceValue(java.lang.String uuid)

Protected constructor creating a ReferenceValue object without validating the UUID format.

Parameters:

uuid - the UUID of the node to be referenced

See Also:

valueOf(java.lang.String)

Method Detail

valueOf

public static ReferenceValue valueOf(java.lang.String s)
                              throws javax.jcr.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:

javax.jcr.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()

getInternalString

protected java.lang.String getInternalString()
                                      throws javax.jcr.ValueFormatException

Returns the internal string representation of this value without modifying the value state.

Specified by:

getInternalString in class BaseValue

Returns:

the internal string representation

Throws:

javax.jcr.ValueFormatException - if the value can not be represented as a String or if the value is null.

getDate

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

Specified by:

getDate in interface javax.jcr.Value

Overrides:

getDate in class BaseValue

Throws:

javax.jcr.ValueFormatException

java.lang.IllegalStateException

javax.jcr.RepositoryException

getLong

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

Specified by:

getLong in interface javax.jcr.Value

Overrides:

getLong in class BaseValue

Throws:

javax.jcr.ValueFormatException

java.lang.IllegalStateException

javax.jcr.RepositoryException

getBoolean

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

Specified by:

getBoolean in interface javax.jcr.Value

Overrides:

getBoolean in class BaseValue

Throws:

javax.jcr.ValueFormatException

java.lang.IllegalStateException

javax.jcr.RepositoryException

getDouble

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

Specified by:

getDouble in interface javax.jcr.Value

Overrides:

getDouble in class BaseValue

Throws:

javax.jcr.ValueFormatException

java.lang.IllegalStateException

javax.jcr.RepositoryException