org.apache.jackrabbit.value
Class BaseValue

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

All Implemented Interfaces:

javax.jcr.Value

Direct Known Subclasses:

BinaryValue, BooleanValue, DateValue, DoubleValue, LongValue, NameValue, PathValue, ReferenceValue, StringValue

public abstract class BaseValue
extends java.lang.Object
implements javax.jcr.Value

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

See Also:

Value, StringValue, LongValue, DoubleValue, BooleanValue, DateValue, BinaryValue, NameValue, PathValue, ReferenceValue

Field Summary

protected static java.lang.String	DEFAULT_ENCODING
protected java.io.InputStream	stream
protected int	type

Method Summary

boolean	getBoolean()
java.util.Calendar	getDate()
double	getDouble()
protected abstract java.lang.String	getInternalString() Returns the internal string representation of this value without modifying the value state.
long	getLong()
java.io.InputStream	getStream()
java.lang.String	getString()
int	getType()
protected void	setStreamConsumed() Checks if the non-stream value of this instance has already been consumed (if any getter methods except getStream() and getType() have been previously called at least once) and sets the state to STATE_STREAM_CONSUMED.
protected void	setValueConsumed() Checks if the stream value of this instance has already been consumed (if getStream() has been previously called at least once) and sets the state to STATE_VALUE_CONSUMED.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ENCODING

protected static final java.lang.String DEFAULT_ENCODING

See Also:

Constant Field Values

type

protected final int type

stream

protected java.io.InputStream stream

Method Detail

setStreamConsumed

protected void setStreamConsumed()
                          throws java.lang.IllegalStateException

Checks if the non-stream value of this instance has already been consumed (if any getter methods except getStream() and getType() have been previously called at least once) and sets the state to STATE_STREAM_CONSUMED.

Throws:

java.lang.IllegalStateException - if any getter methods other than getStream() and getType() have been previously called at least once.

setValueConsumed

protected void setValueConsumed()
                         throws java.lang.IllegalStateException

Checks if the stream value of this instance has already been consumed (if getStream() has been previously called at least once) and sets the state to STATE_VALUE_CONSUMED.

Throws:

java.lang.IllegalStateException - if getStream() has been previously called at least once.

getInternalString

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

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

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.

javax.jcr.RepositoryException - if another error occurs.

getType

public int getType()

Specified by:

getType in interface javax.jcr.Value

getDate

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

Specified by:

getDate in interface javax.jcr.Value

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

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

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

Throws:

javax.jcr.ValueFormatException

java.lang.IllegalStateException

javax.jcr.RepositoryException

getStream

public java.io.InputStream getStream()
                              throws java.lang.IllegalStateException,
                                     javax.jcr.RepositoryException

Specified by:

getStream in interface javax.jcr.Value

Throws:

java.lang.IllegalStateException

javax.jcr.RepositoryException

getString

public java.lang.String getString()
                           throws javax.jcr.ValueFormatException,
                                  java.lang.IllegalStateException,
                                  javax.jcr.RepositoryException

Specified by:

getString in interface javax.jcr.Value

Throws:

javax.jcr.ValueFormatException

java.lang.IllegalStateException

javax.jcr.RepositoryException