Package org.htmlunit.xpath.objects

Class XBoolean

java.lang.Object

org.htmlunit.xpath.Expression

org.htmlunit.xpath.objects.XObject

org.htmlunit.xpath.objects.XBoolean

All Implemented Interfaces:

SourceLocator, ExpressionNode, XPathVisitable

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.

Field Summary

Fields

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

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

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

Constructor Summary

Constructors

Constructor	Description
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 what kind of class this is.
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.htmlunit.xpath.objects.XObject

boolWithSideEffects, callVisitors, deepEquals, detach, error, error, execute, greaterThan, greaterThanOrEqual, iter, lessThan, lessThanOrEqual, mutableNodeset, nodelist, nodeset, notEquals, numWithSideEffects, setObject, toString, xstr

Methods inherited from class org.htmlunit.xpath.Expression

asIterator, asNode, assertion, bool, canTraverseOutsideSubtree, error, execute, execute, execute, exprGetParent, exprSetParent, getColumnNumber, getExpressionOwner, getLineNumber, getPublicId, getSystemId, isSameClass, isStableNumber, num

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.

m_val

private final boolean m_val

Value of the object.

Constructor Details

XBoolean

public XBoolean(boolean b)

Construct a XBoolean object.

Parameters:

b - Value of the boolean object

Method Details

getType

public int getType()

Tell what kind of class this is.

Overrides:

getType in class XObject

Returns:

CLASS_UNKNOWN

getTypeString

public String getTypeString()

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

Overrides:

getTypeString in class XObject

Returns:

type string "#UNKNOWN" + object class name

num

public double num()

Cast result object to a number. Always issues an error.

Overrides:

num in class XObject

Returns:

0.0

bool

public boolean bool()

Cast result object to a boolean. Always issues an error.

Overrides:

bool in class XObject

Returns:

false

str

public String str()

Cast result object to a string.

Overrides:

str in class XObject

Returns:

The object 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 that this class wraps

equals

public boolean equals(XObject obj2)

Tell if two objects are functionally equal.

Overrides:

equals in class XObject

Parameters:

obj2 - Object to compare this to

Returns:

True if this object is equal to the given object