org.apache.xpath.objects
Class XStringForChars

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

public class XStringForChars

extends XString

This class will wrap a FastStringBuffer and allow for

See Also:

Serialized Form

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

EMPTYSTRING

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

XStringForChars(char[] val, int start, int length)
Construct a XNodeSet object.

Method Summary

void	appendToFsb(FastStringBuffer fsb) Cast result object to a string.
char	charAt(int index) Returns the character at the specified index.
void	dispatchAsComment(LexicalHandler lh) Directly call the comment method on the passed LexicalHandler for the string-value.
void	dispatchCharactersEvents(ContentHandler ch) Directly call the characters method on the passed ContentHandler for the string-value.
FastStringBuffer	fsb() Cast result object to a string.
void	getChars(int srcBegin, int srcEnd, char[] dst, int dstBegin) Copies characters from this string into the destination character array.
boolean	hasString() Tell if this object contains a java String object.
int	length() Returns the length of this string.
java.lang.Object	object() Since this object is incomplete without the length and the offset, we have to convert to a string when this function is called.
java.lang.String	str() Cast result object to a string.

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

bool, callVisitors, compareTo, compareToIgnoreCase, concat, endsWith, equals, equals, equals, equalsIgnoreCase, fixWhiteSpace, getType, getTypeString, hashCode, indexOf, indexOf, indexOf, indexOf, indexOf, lastIndexOf, lastIndexOf, lastIndexOf, lastIndexOf, num, rtf, startsWith, startsWith, startsWith, startsWith, substring, substring, toDouble, toLowerCase, toLowerCase, toUpperCase, toUpperCase, trim, xstr

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

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

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, isStableNumber, num, warn, xstr

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

XStringForChars

public XStringForChars(char[] val,
                       int start,
                       int length)

Construct a XNodeSet object.

Parameters:

val - FastStringBuffer object this will wrap, must be non-null.

start - The start position in the array.

length - The number of characters to read from the array.

Method Detail

fsb

public FastStringBuffer fsb()

Cast result object to a string.

Returns:

The string this wraps or the empty string if null

appendToFsb

public void appendToFsb(FastStringBuffer fsb)

Cast result object to a string.

Returns:

The string this wraps or the empty string if null

Overrides:

appendToFsb in class XObject

hasString

public boolean hasString()

Tell if this object contains a java String object.

Returns:

true if this XMLString can return a string without creating one.

Overrides:

hasString in class XString

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 XString

object

public java.lang.Object object()

Since this object is incomplete without the length and the offset, we have to convert to a string when this function is called.

Returns:

The java String representation of this object.

Overrides:

object in class XObject

dispatchCharactersEvents

public void dispatchCharactersEvents(ContentHandler ch)
                              throws SAXException

Directly call the characters method on the passed ContentHandler for the string-value. Multiple calls to the ContentHandler's characters methods may well occur for a single call to this method.

Parameters:

ch - A non-null reference to a ContentHandler.

Throws:

SAXException -

Overrides:

dispatchCharactersEvents in class XString

dispatchAsComment

public void dispatchAsComment(LexicalHandler lh)
                       throws SAXException

Directly call the comment method on the passed LexicalHandler for the string-value.

Parameters:

lh - A non-null reference to a LexicalHandler.

Throws:

SAXException -

Overrides:

dispatchAsComment in class XString

length

public int length()

Returns the length of this string.

Returns:

the length of the sequence of characters represented by this object.

Overrides:

length in class XString

charAt

public char charAt(int index)

Returns the character at the specified index. An index ranges from 0 to length() - 1. The first character of the sequence is at index 0, the next at index 1, and so on, as for array indexing.

Parameters:

index - the index of the character.

Returns:

the character at the specified index of this string. The first character is at index 0.

Throws:

java.lang.IndexOutOfBoundsException - if the index argument is negative or not less than the length of this string.

Overrides:

charAt in class XString

getChars

public void getChars(int srcBegin,
                     int srcEnd,
                     char[] dst,
                     int dstBegin)

Copies characters from this string into the destination character array.

Parameters:

srcBegin - index of the first character in the string to copy.

srcEnd - index after the last character in the string to copy.

dst - the destination array.

dstBegin - the start offset in the destination array.

Throws:

java.lang.IndexOutOfBoundsException - If any of the following is true:

• srcBegin is negative.
• srcBegin is greater than srcEnd
• srcEnd is greater than the length of this string
• dstBegin is negative
• dstBegin+(srcEnd-srcBegin) is larger than dst.length

java.lang.NullPointerException - if dst is null

Overrides:

getChars in class XString