org.apache.jackrabbit.value

Class BinaryValue

java.lang.Object

org.apache.jackrabbit.value.BaseValue

org.apache.jackrabbit.value.BinaryValue

All Implemented Interfaces:

Value

public class BinaryValue
extends BaseValue

A BinaryValue provides an implementation of the Value interface representing a binary value.

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE

Constructor Summary

Constructors

Constructor and Description
BinaryValue(Binary bin) Constructs a BinaryValue object based on a Binary.
BinaryValue(byte[] data) Constructs a BinaryValue object based on a byte array.
BinaryValue(java.io.InputStream stream) Constructs a BinaryValue object based on a stream.
BinaryValue(java.lang.String text) Constructs a BinaryValue object based on a string.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Indicates whether some other object is "equal to" this one.
Binary	getBinary() Returns a Binary representation of this value.
java.lang.String	getInternalString() Gets the string representation of this binary value.
java.io.InputStream	getStream() Returns an InputStream representation of this value.
int	hashCode() Returns zero to satisfy the Object equals/hashCode contract.

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

getBoolean, getDate, getDecimal, getDouble, getLong, 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

BinaryValue

public BinaryValue(java.lang.String text)

Constructs a BinaryValue object based on a string.

Parameters:

text - the string this BinaryValue should represent

BinaryValue

public BinaryValue(Binary bin)

Constructs a BinaryValue object based on a Binary.

Parameters:

bin - the bytes this BinaryValue should represent

BinaryValue

public BinaryValue(java.io.InputStream stream)

Constructs a BinaryValue object based on a stream.

Parameters:

stream - the stream this BinaryValue should represent

BinaryValue

public BinaryValue(byte[] data)

Constructs a BinaryValue object based on a byte array.

Parameters:

data - the bytes this BinaryValue should represent

Method Detail

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 BinaryValue 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

public java.lang.String getInternalString()
                                   throws ValueFormatException,
                                          RepositoryException

Gets the string representation of this binary value.

Returns:

string representation of this binary value.

Throws:

ValueFormatException

RepositoryException - if another error occurs

getStream

public java.io.InputStream getStream()
                              throws java.lang.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

Overrides:

getStream in class BaseValue

Returns:

An InputStream representation of this value.

Throws:

RepositoryException - if an error occurs.

java.lang.IllegalStateException

getBinary

public Binary getBinary()
                 throws ValueFormatException,
                        java.lang.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

Overrides:

getBinary in class BaseValue

Returns:

A Binary representation of this value.

Throws:

RepositoryException - if an error occurs.

ValueFormatException

java.lang.IllegalStateException