org.exolab.adaptx.xpath
Class StringResult

java.lang.Object
  extended by org.exolab.adaptx.xpath.XPathResult
      extended by org.exolab.adaptx.xpath.StringResult
All Implemented Interfaces:
java.io.Serializable

public final class StringResult
extends XPathResult

Represents a string result. This is an immutable object.

Version:
$Revision: 3633 $ $Date: 2003-03-01 02:38:44 -0500 (Sat, 01 Mar 2003) $
Author:
Keith Visco
See Also:
Serialized Form

Field Summary
static StringResult EMPTY
          String result representing an empty string.
 
Fields inherited from class org.exolab.adaptx.xpath.XPathResult
BOOLEAN, NODE_SET, NUMBER, STRING, USER_DEFINED
 
Constructor Summary
StringResult()
          Creates a new string result with an empty string as it's value.
StringResult(java.lang.String value)
          Creates a new string result with the given value.
 
Method Summary
 boolean booleanValue()
          Returns the result as a boolean value.
 boolean equals(XPathResult result)
          Returns true if the given result is a string result and has the same string value.
 int getResultType()
          Returns the type of this result.
 java.lang.Object javaObject()
          Returns the result as a Java object.
 double numberValue()
          Returns the result as a number value.
 java.lang.String stringValue()
          Returns the result as a string value.
 java.lang.String toString()
          Returns the String representation of this XPathResult
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

EMPTY

public static final StringResult EMPTY
String result representing an empty string.

Constructor Detail

StringResult

public StringResult()
Creates a new string result with an empty string as it's value.


StringResult

public StringResult(java.lang.String value)
Creates a new string result with the given value.

Parameters:
value - The string value (not null)
Method Detail

getResultType

public int getResultType()
Returns the type of this result.

Specified by:
getResultType in class XPathResult
Returns:
XPathResult.STRING

booleanValue

public boolean booleanValue()
Returns the result as a boolean value. Returns true if not an empty string.

Specified by:
booleanValue in class XPathResult
Returns:
The result as a boolean value

numberValue

public double numberValue()
Returns the result as a number value. Returns Double.NaN if the value is not a valid number.

Specified by:
numberValue in class XPathResult
Returns:
The result as a number value

stringValue

public java.lang.String stringValue()
Returns the result as a string value.

Specified by:
stringValue in class XPathResult
Returns:
The result as a string value

javaObject

public java.lang.Object javaObject()
Returns the result as a Java object. Returns an object of type String with the same string value.

Specified by:
javaObject in class XPathResult
Returns:
The result as a Java object

equals

public boolean equals(XPathResult result)
Returns true if the given result is a string result and has the same string value.

Specified by:
equals in class XPathResult
Parameters:
result - An XPath result
Returns:
True if a string result and has same value

toString

public java.lang.String toString()
Returns the String representation of this XPathResult

Overrides:
toString in class java.lang.Object
Returns:
the String representation of this XPathResult