Package org.apache.xpath.objects

Class XBoolean

java.lang.Object

org.apache.xpath.Expression

org.apache.xpath.objects.XObject

org.apache.xpath.objects.XBoolean

All Implemented Interfaces:

Serializable, Cloneable, SourceLocator, ExpressionNode, XPathVisitable

Direct Known Subclasses:

XBooleanStatic

public class XBoolean
extends XObject

This class represents an XPath boolean object, and is capable of converting the boolean to other types, such as a string.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static XBoolean	S_FALSE	A true boolean object so we don't have to keep creating them.
static XBoolean	S_TRUE	A true boolean object so we don't have to keep creating them.

Fields inherited from class org.apache.xpath.objects.XObject

CLASS_BOOLEAN, CLASS_NODESET, CLASS_NULL, CLASS_NUMBER, CLASS_RTREEFRAG, CLASS_STRING, CLASS_UNKNOWN, CLASS_UNRESOLVEDVARIABLE, m_obj

Constructor Summary

Constructors

Constructor	Description
XBoolean(boolean b)	Construct a XBoolean object.
XBoolean(Boolean b)	Construct a XBoolean object.

Method Summary

Modifier and Type	Method	Description
boolean	bool()	Cast result object to a boolean.
boolean	equals(XObject obj2)	Tell if two objects are functionally equal.
int	getType()	Tell that this is a CLASS_BOOLEAN.
String	getTypeString()	Given a request type, return the equivalent string.
double	num()	Cast result object to a number.
Object	object()	Return a java object that's closest to the representation that should be handed to an extension.
String	str()	Cast result object to a string.

Methods inherited from class org.apache.xpath.objects.XObject

allowDetachToRelease, appendToFsb, boolWithSideEffects, callVisitors, castToType, create, create, deepEquals, destruct, detach, dispatchCharactersEvents, error, error, execute, fixupVariables, getFresh, greaterThan, greaterThanOrEqual, iter, lessThan, lessThanOrEqual, mutableNodeset, nodelist, nodeset, notEquals, numWithSideEffects, reset, rtf, rtf, rtree, rtree, setObject, toString, xstr

Methods inherited from class org.apache.xpath.Expression

asIterator, asIteratorRaw, asNode, assertion, bool, canTraverseOutsideSubtree, error, execute, execute, execute, executeCharsToContentHandler, exprAddChild, exprGetChild, exprGetNumChildren, exprGetParent, exprSetParent, getColumnNumber, getExpressionOwner, getLineNumber, getPublicId, getSystemId, isNodesetExpr, isSameClass, isStableNumber, num, warn, xstr

Methods inherited from class java.lang.Object

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

Field Details

S_TRUE

public static final XBoolean S_TRUE

A true boolean object so we don't have to keep creating them.

S_FALSE

public static final XBoolean S_FALSE

A true boolean object so we don't have to keep creating them.

Constructor Details

XBoolean

public XBoolean(boolean b)

Construct a XBoolean object.

Parameters:

b - Value of the boolean object

XBoolean

public XBoolean(Boolean b)

Construct a XBoolean object.

Parameters:

b - Value of the boolean object

Method Details

getType

public int getType()

Tell that this is a CLASS_BOOLEAN.

Overrides:

getType in class XObject

Returns:

type of CLASS_BOOLEAN

getTypeString

public String getTypeString()

Given a request type, return the equivalent string. For diagnostic purposes.

Overrides:

getTypeString in class XObject

Returns:

type string "#BOOLEAN"

num

public double num()

Cast result object to a number.

Overrides:

num in class XObject

Returns:

numeric value of the object value

bool

public boolean bool()

Cast result object to a boolean.

Overrides:

bool in class XObject

Returns:

The object value as a boolean

str

public String str()

Cast result object to a string.

Overrides:

str in class XObject

Returns:

The object's value as a string

object

public Object object()

Return a java object that's closest to the representation that should be handed to an extension.

Overrides:

object in class XObject

Returns:

The object's value as a java object

equals

public boolean equals(XObject obj2)

Tell if two objects are functionally equal.

Overrides:

equals in class XObject

Parameters:

obj2 - Object to compare to this

Returns:

True if the two objects are equal

Throws:

TransformerException