org.apache.xpath.objects
Class XString

java.lang.Object
  |
  +--org.apache.xpath.Expression
        |
        +--org.apache.xpath.objects.XObject
              |
              +--org.apache.xpath.objects.XString

public class XString

extends XObject

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

See Also:

Serialized Form

Field Summary

static XString

EMPTYSTRING Empty string XString object

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

Constructor Summary

XString(java.lang.String val)
Construct a XNodeSet object.

Method Summary

boolean	bool() Cast result object to a boolean.
static double	castToNum(java.lang.String s) Cast a string to a number.
boolean	equals(XObject obj2) Tell if two objects are functionally equal.
int	getType() Tell that this is a CLASS_STRING.
java.lang.String	getTypeString() Given a request type, return the equivalent string.
double	num() Cast result object to a number.
DocumentFragment	rtree(XPathContext support) Cast result object to a result tree fragment.
java.lang.String	str() Cast result object to a string.

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

castToType, create, execute, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual, mutableNodeset, nodeset, notEquals, object, rtree, toString

Methods inherited from class org.apache.xpath.Expression

assert, canTraverseOutsideSubtree, error, setSourceLocator, warn

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EMPTYSTRING

public static XString EMPTYSTRING

Empty string XString object

Constructor Detail

XString

public XString(java.lang.String val)

Construct a XNodeSet object.

Parameters:

val - String object this will wrap.

Method Detail

getType

public int getType()

Tell that this is a CLASS_STRING.

Returns:

type CLASS_STRING

Overrides:

getType in class XObject

getTypeString

public java.lang.String getTypeString()

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

Returns:

type string "#STRING"

Overrides:

getTypeString in class XObject

castToNum

public static double castToNum(java.lang.String s)

Cast a string to a number.

Parameters:

s - The string to convert

Returns:

0.0 if the string is null, numeric value of the string or NaN

num

public double num()

Cast result object to a number.

Returns:

0.0 if this string is null, numeric value of this string or NaN

Overrides:

num in class XObject

bool

public boolean bool()

Cast result object to a boolean.

Returns:

True if the length of this string object is greater than 0.

Overrides:

bool in class XObject

str

public java.lang.String str()

Cast result object to a string.

Returns:

The string this wraps or the empty string if null

Overrides:

str in class XObject

rtree

public DocumentFragment rtree(XPathContext support)

Cast result object to a result tree fragment.

Parameters:

support - Xpath context to use for the conversion

Returns:

A document fragment with this string as a child node

Overrides:

rtree in class XObject

equals

public boolean equals(XObject obj2)
               throws TransformerException

Tell if two objects are functionally equal.

Parameters:

obj2 - Object to compare this to

Returns:

true if the two objects are equal

Throws:

TransformerException -

Overrides:

equals in class XObject