QValue (Jackrabbit SPI 1.6.2 API)

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.jackrabbit.spi
Interface QValue

public interface QValue

QValue is the qualified SPI representation of a jcr value. It therefore refers to Names and Paths only and is thus isolated from session-specific namespace mappings.

Field Summary
`static QValue[]`	`EMPTY_ARRAY`

Method Summary
`void`	`discard()` Frees temporarily allocated resources such as temporary file, buffer, etc.
`boolean`	`getBoolean()` Returns a `boolean` representation of this value.
`Calendar`	`getCalendar()` Returns a `Calendar` representation of this value.
`double`	`getDouble()` Returns a `double` representation of this value.
`long`	`getLength()` Returns the length of the internal value or -1 if the implementation cannot determine the length at this time. NOTE: for `PropertyType.NAME` and `PropertyType.PATH` the length of the internal value must not be used for indicating the length of a property such as retrieved by calling `Property.getLength()` and `Property.getLengths()`.
`long`	`getLong()` Returns a `long` representation of this value.
`Name`	`getName()` Returns a `Name` representation of this value.
`Path`	`getPath()` Returns a `Path` representation of this value.
`InputStream`	`getStream()` Returns a `InputStream` representation of this `QValue` object.
`String`	`getString()` Returns a `String` representation of this `QValue` object.
`int`	`getType()` Returns the `PropertyType` of this `QValue` object.

Field Detail

EMPTY_ARRAY

static final QValue[] EMPTY_ARRAY

Method Detail

getType

int getType()

Returns the PropertyType of this QValue object. It may be either of the value property types defined by the JSR 170:

Returns:: the PropertyType of this QValue object.

getLength

long getLength()
               throws RepositoryException

Returns the length of the internal value or -1 if the implementation cannot determine the length at this time.
NOTE: for PropertyType.NAME and PropertyType.PATH the length of the internal value must not be used for indicating the length of a property such as retrieved by calling Property.getLength() and Property.getLengths().

Returns:: length of this QValue object.
Throws:: RepositoryException

getString

String getString()
                 throws RepositoryException

Returns a String representation of this QValue object.

Returns:: A String representation of this QValue object.
Throws:: RepositoryException

getStream

InputStream getStream()
                      throws RepositoryException

Returns a InputStream representation of this QValue object.

Returns:: A stream representation of this value.
Throws:: RepositoryException

getCalendar

Calendar getCalendar()
                     throws RepositoryException

Returns a Calendar representation of this value.

Returns:: A Calendar representation of this value.
Throws:: RepositoryException - if an error occurs.

getDouble

double getDouble()
                 throws RepositoryException

Returns a double representation of this value.

Returns:: A double representation of this value.
Throws:: RepositoryException - if an error occurs.

getLong

long getLong()
             throws RepositoryException

Returns a long representation of this value.

Returns:: A long representation of this value.
Throws:: RepositoryException - if an error occurs.

getBoolean

boolean getBoolean()
                   throws RepositoryException

Returns a boolean representation of this value.

Returns:: A boolean representation of this value.
Throws:: RepositoryException - if an error occurs.

getName

Name getName()
             throws RepositoryException

Returns a Name representation of this value.

Returns:: A Name representation of this value.
Throws:: RepositoryException - if an error occurs.

getPath

Path getPath()
             throws RepositoryException

Returns a Path representation of this value.

Returns:: A Path representation of this value.
Throws:: RepositoryException - if an error occurs.

discard

void discard()

Frees temporarily allocated resources such as temporary file, buffer, etc.