org.exist.xquery.value
Class BooleanValue

java.lang.Object
  org.exist.xquery.value.AtomicValue
      org.exist.xquery.value.BooleanValue

All Implemented Interfaces:

java.lang.Comparable, Indexable, Item, Sequence

public class BooleanValue

extends AtomicValue

implements Indexable

Field Summary

static BooleanValue	FALSE
static BooleanValue	TRUE

Fields inherited from class org.exist.xquery.value.AtomicValue

EMPTY_VALUE

Fields inherited from interface org.exist.xquery.value.Sequence

EMPTY_SEQUENCE

Constructor Summary

BooleanValue(boolean bool)

Method Summary

int	compareTo(java.text.Collator collator, AtomicValue other)
boolean	compareTo(java.text.Collator collator, int operator, AtomicValue other)
int	compareTo(java.lang.Object o)
int	conversionPreference(java.lang.Class javaClass) Returns a preference indicator, indicating the preference of a value to be converted into the given Java class.
AtomicValue	convertTo(int requiredType) Convert this item into an atomic value, whose type corresponds to the specified target type.
boolean	effectiveBooleanValue() Get the effective boolean value of this sequence.
java.lang.String	getStringValue() Return the string value of this item (see the definition of string value in XPath).
int	getType() Returns the type of the Indexable as one of the constants defined in Type.
boolean	getValue()
AtomicValue	max(java.text.Collator collator, AtomicValue other)
AtomicValue	min(java.text.Collator collator, AtomicValue other)
byte[]	serialize(short collectionId, boolean caseSensitive) Serialize the value plus collection and possibly element information to an array of bytes.
byte[]	serializeValue(int offset, boolean caseSensitive) serialize for the persistant storage
java.lang.Object	toJavaObject(java.lang.Class target) Convert the value into an instance of the specified Java class.
static BooleanValue	valueOf(boolean bool) Returns one of the static fields TRUE or FALSE depending on the value of the parameter.

Methods inherited from class org.exist.xquery.value.AtomicValue

add, addAll, atomize, clearContext, contains, copyTo, dump, endsWith, getCardinality, getDocumentSet, getItemType, getLength, isCached, isPersistentSet, itemAt, iterate, removeDuplicates, setIsCached, setSelfAsContext, startsWith, toNodeSet, toSAX, toSequence, toString, unorderedIterator

Methods inherited from class java.lang.Object

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

Field Detail

TRUE

public static final BooleanValue TRUE

FALSE

public static final BooleanValue FALSE

Constructor Detail

BooleanValue

public BooleanValue(boolean bool)

Method Detail

valueOf

public static final BooleanValue valueOf(boolean bool)

Returns one of the static fields TRUE or FALSE depending on the value of the parameter.

Parameters:

bool -

Returns:

getType

public int getType()

Description copied from interface: Indexable

Returns the type of the Indexable as one of the constants defined in Type.

Specified by:

getType in interface Indexable

Overrides:

getType in class AtomicValue

getStringValue

public java.lang.String getStringValue()
                                throws XPathException

Description copied from interface: Item

Return the string value of this item (see the definition of string value in XPath).

Specified by:

getStringValue in interface Item

Specified by:

getStringValue in class AtomicValue

Throws:

XPathException

convertTo

public AtomicValue convertTo(int requiredType)
                      throws XPathException

Description copied from interface: Item

Convert this item into an atomic value, whose type corresponds to the specified target type. requiredType should be one of the type constants defined in Type. An XPathException is thrown if the conversion is impossible.

Specified by:

convertTo in interface Item

Specified by:

convertTo in class AtomicValue

Throws:

XPathException

compareTo

public boolean compareTo(java.text.Collator collator,
                         int operator,
                         AtomicValue other)
                  throws XPathException

Specified by:

compareTo in class AtomicValue

Throws:

XPathException

compareTo

public int compareTo(java.text.Collator collator,
                     AtomicValue other)
              throws XPathException

Specified by:

compareTo in class AtomicValue

Throws:

XPathException

effectiveBooleanValue

public boolean effectiveBooleanValue()
                              throws XPathException

Description copied from interface: Sequence

Get the effective boolean value of this sequence. Will be false if the sequence is empty, true otherwise.

Specified by:

effectiveBooleanValue in interface Sequence

Overrides:

effectiveBooleanValue in class AtomicValue

Throws:

XPathException

getValue

public boolean getValue()

max

public AtomicValue max(java.text.Collator collator,
                       AtomicValue other)
                throws XPathException

Specified by:

max in class AtomicValue

Throws:

XPathException

min

public AtomicValue min(java.text.Collator collator,
                       AtomicValue other)
                throws XPathException

Specified by:

min in class AtomicValue

Throws:

XPathException

conversionPreference

public int conversionPreference(java.lang.Class javaClass)

Description copied from interface: Sequence

Returns a preference indicator, indicating the preference of a value to be converted into the given Java class. Low numbers mean that the value can be easily converted into the given class.

Specified by:

conversionPreference in interface Item

Overrides:

conversionPreference in class AtomicValue

toJavaObject

public java.lang.Object toJavaObject(java.lang.Class target)
                              throws XPathException

Description copied from interface: Sequence

Convert the value into an instance of the specified Java class.

Specified by:

toJavaObject in interface Item

Overrides:

toJavaObject in class AtomicValue

Throws:

XPathException

serialize

public byte[] serialize(short collectionId,
                        boolean caseSensitive)

Deprecated.

Description copied from interface: Indexable

Serialize the value plus collection and possibly element information to an array of bytes.

Specified by:

serialize in interface Indexable

Parameters:

collectionId - the collection id to use

caseSensitive - only relevant for string values: if set to false, strings should be serialized in lower case

Returns:

See Also:

org.exist.storage.Indexable#serialize(short)

serializeValue

public byte[] serializeValue(int offset,
                             boolean caseSensitive)

serialize for the persistant storage

Specified by:

serializeValue in interface Indexable

Returns:

the size actually writen in the array argument

See Also:

Indexable.serializeValue(int, boolean)

compareTo

public int compareTo(java.lang.Object o)

Specified by:

compareTo in interface java.lang.Comparable