Package org.apache.jackrabbit.value

Class BaseValue

java.lang.Object

org.apache.jackrabbit.value.BaseValue

All Implemented Interfaces:

Value

Direct Known Subclasses:

BinaryValue, BooleanValue, DateValue, DecimalValue, DoubleValue, LongValue, NameValue, PathValue, ReferenceValue, StringValue, URIValue, WeakReferenceValue

public abstract class BaseValue
extends Object
implements Value

This class is the superclass of the type-specific classes implementing the Value interfaces.

See Also:

• Value
• StringValue
• LongValue
• DoubleValue
• DecimalValue
• BooleanValue
• DateValue
• BinaryValue
• NameValue
• PathValue
• URIValue
• ReferenceValue
• WeakReferenceValue

Method Summary

Modifier and Type	Method	Description
Binary	getBinary()	Returns a Binary representation of this value.
boolean	getBoolean()	Returns a Boolean representation of this value.
Calendar	getDate()	Returns a Calendar representation of this value.
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.
InputStream	getStream()	Returns an InputStream representation of this value.
String	getString()	Returns a String representation of this value.
int	getType()	Returns the type of this Value.

Methods inherited from class java.lang.Object

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

Method Details

getType

public int getType()

Returns the type of this Value. One of:

• PropertyType.STRING
• PropertyType.DATE
• PropertyType.BINARY
• PropertyType.DOUBLE
• PropertyType.DECIMAL
• PropertyType.LONG
• PropertyType.BOOLEAN
• PropertyType.NAME
• PropertyType.PATH
• PropertyType.REFERENCE
• PropertyType.WEAKREFERENCE
• PropertyType.URI

See PropertyType.

The type returned is that which was set at property creation.

Specified by:

getType in interface Value

Returns:

an int

getDate

public Calendar getDate()
                 throws ValueFormatException,
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

Returns:

A Calendar representation of this value.

Throws:

ValueFormatException - if conversion to a Calendar is not possible.

RepositoryException - if another error occurs.

IllegalStateException

getLong

public long getLong()
             throws ValueFormatException,
IllegalStateException,
RepositoryException

Returns a long representation of this value.

Specified by:

getLong in interface Value

Returns:

A long representation of this value.

Throws:

ValueFormatException - if conversion to an long is not possible.

RepositoryException - if another error occurs.

IllegalStateException

getBoolean

public boolean getBoolean()
                   throws ValueFormatException,
IllegalStateException,
RepositoryException

Returns a Boolean representation of this value.

Specified by:

getBoolean in interface Value

Returns:

A Boolean representation of this value.

Throws:

ValueFormatException - if conversion to a Boolean is not possible.

RepositoryException - if another error occurs.

IllegalStateException

getDouble

public double getDouble()
                 throws ValueFormatException,
IllegalStateException,
RepositoryException

Returns a double representation of this value.

Specified by:

getDouble in interface Value

Returns:

A double representation of this value.

Throws:

ValueFormatException - if conversion to a double is not possible.

RepositoryException - if another error occurs.

IllegalStateException

getDecimal

public BigDecimal getDecimal()
                      throws ValueFormatException,
IllegalStateException,
RepositoryException

Returns a BigDecimal representation of this value.

Specified by:

getDecimal in interface Value

Returns:

A BigDecimal representation of this value.

Throws:

ValueFormatException - if conversion to a BigDecimal is not possible.

RepositoryException - if another error occurs.

IllegalStateException

getStream

public InputStream getStream()
                      throws IllegalStateException,
RepositoryException

Returns an InputStream representation of this value. Uses the standard conversion to binary (see JCR specification).

It is the responsibility of the caller to close the returned InputStream.

Specified by:

getStream in interface Value

Returns:

An InputStream representation of this value.

Throws:

RepositoryException - if an error occurs.

IllegalStateException

getBinary

public Binary getBinary()
                 throws ValueFormatException,
IllegalStateException,
RepositoryException

Returns a Binary representation of this value. The Binary object in turn provides methods to access the binary data itself. Uses the standard conversion to binary (see JCR specification).

Specified by:

getBinary in interface Value

Returns:

A Binary representation of this value.

Throws:

RepositoryException - if an error occurs.

ValueFormatException

IllegalStateException

getString

public String getString()
                 throws ValueFormatException,
IllegalStateException,
RepositoryException

Returns a String representation of this value.

Specified by:

getString in interface Value

Returns:

A String representation of the value of this property.

Throws:

ValueFormatException - if conversion to a String is not possible.

IllegalStateException - if getStream has previously been called on this Value instance. In this case a new Value instance must be acquired in order to successfully call this method.

RepositoryException - if another error occurs.