Class XStringForFSB
- All Implemented Interfaces:
Serializable
,Cloneable
,SourceLocator
,XMLString
,ExpressionNode
,XPathVisitable
- See Also:
-
Field Summary
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
ConstructorsConstructorDescriptionXStringForFSB
(FastStringBuffer val, int start, int length) Construct a XNodeSet object. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Cast result object to a string.char
charAt
(int index) Returns the character at the specified index.int
Compares two strings lexicographically.int
compareToIgnoreCase
(XMLString xstr) Compares two strings lexicographically, ignoring case considerations.Concatenates the specified string to the end of this string.void
Directly call the comment method on the passed LexicalHandler for the string-value.void
Directly call the characters method on the passed ContentHandler for the string-value.boolean
Compares this string to the specified object.boolean
Tell if two objects are functionally equal.boolean
Compares this string to the specified object.boolean
Tell if two objects are functionally equal.boolean
equalsIgnoreCase
(String anotherString) Compares thisString
to anotherString
, ignoring case considerations.fixWhiteSpace
(boolean trimHead, boolean trimTail, boolean doublePunctuationSpaces) Conditionally trim all leading and trailing whitespace in the specified String.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.int
hashCode()
Returns a hashcode for this string.boolean
Tell if this object contains a java String object.int
indexOf
(int ch) Returns the index within this string of the first occurrence of the specified character.int
indexOf
(int ch, int fromIndex) Returns the index within this string of the first occurrence of the specified character, starting the search at the specified index.int
length()
Returns the length of this string.object()
Since this object is incomplete without the length and the offset, we have to convert to a string when this function is called.boolean
startsWith
(XMLString prefix) Tests if this string starts with the specified prefix.boolean
startsWith
(XMLString prefix, int toffset) Tests if this string starts with the specified prefix beginning a specified index.str()
Cast result object to a string.substring
(int beginIndex) Returns a new string that is a substring of this string.substring
(int beginIndex, int endIndex) Returns a new string that is a substring of this string.double
toDouble()
Convert a string to a double -- Allowed input is in fixed notation ddd.fff.trim()
Removes white space from both ends of this string.Methods inherited from class org.apache.xpath.objects.XString
bool, callVisitors, endsWith, getType, getTypeString, indexOf, indexOf, indexOf, lastIndexOf, lastIndexOf, lastIndexOf, lastIndexOf, num, rtf, startsWith, startsWith, toLowerCase, toLowerCase, toUpperCase, toUpperCase, 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
-
Constructor Details
-
XStringForFSB
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 Details
-
fsb
Cast result object to a string.- Returns:
- The string this wraps or the empty string if null
-
appendToFsb
Cast result object to a string.- Overrides:
appendToFsb
in classXObject
-
hasString
public boolean hasString()Tell if this object contains a java String 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. -
str
Cast result object to a string. -
dispatchCharactersEvents
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.- Specified by:
dispatchCharactersEvents
in interfaceXMLString
- Overrides:
dispatchCharactersEvents
in classXString
- Parameters:
ch
- A non-null reference to a ContentHandler.- Throws:
SAXException
-
dispatchAsComment
Directly call the comment method on the passed LexicalHandler for the string-value.- Specified by:
dispatchAsComment
in interfaceXMLString
- Overrides:
dispatchAsComment
in classXString
- Parameters:
lh
- A non-null reference to a LexicalHandler.- Throws:
SAXException
-
length
public int length()Returns the length of this string. -
charAt
public char charAt(int index) Returns the character at the specified index. An index ranges from0
tolength() - 1
. The first character of the sequence is at index0
, the next at index1
, and so on, as for array indexing.- Specified by:
charAt
in interfaceXMLString
- Overrides:
charAt
in classXString
- 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:
IndexOutOfBoundsException
- if theindex
argument is negative or not less than the length of this string.
-
getChars
public void getChars(int srcBegin, int srcEnd, char[] dst, int dstBegin) Copies characters from this string into the destination character array.- Specified by:
getChars
in interfaceXMLString
- Overrides:
getChars
in classXString
- 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:
IndexOutOfBoundsException
- If any of the following is true:srcBegin
is negative.srcBegin
is greater thansrcEnd
srcEnd
is greater than the length of this stringdstBegin
is negativedstBegin+(srcEnd-srcBegin)
is larger thandst.length
NullPointerException
- ifdst
isnull
-
equals
Compares this string to the specified object. The result istrue
if and only if the argument is notnull
and is aString
object that represents the same sequence of characters as this object. -
equals
Tell if two objects are functionally equal.- Overrides:
equals
in classXString
- Parameters:
obj2
- Object to compare this to- Returns:
- true if the two objects are equal
- Throws:
TransformerException
-
equals
Tell if two objects are functionally equal.- Specified by:
equals
in interfaceXMLString
- Overrides:
equals
in classXString
- Parameters:
anotherString
- Object to compare this to- Returns:
- true if the two objects are equal
- Throws:
TransformerException
- See Also:
-
equals
Compares this string to the specified object. The result istrue
if and only if the argument is notnull
and is aString
object that represents the same sequence of characters as this object. -
equalsIgnoreCase
Compares thisString
to anotherString
, ignoring case considerations. Two strings are considered equal ignoring case if they are of the same length, and corresponding characters in the two strings are equal ignoring case.- Specified by:
equalsIgnoreCase
in interfaceXMLString
- Overrides:
equalsIgnoreCase
in classXString
- Parameters:
anotherString
- theString
to compare thisString
against.- Returns:
true
if the argument is notnull
and theString
s are equal, ignoring case;false
otherwise.- See Also:
-
compareTo
Compares two strings lexicographically.- Specified by:
compareTo
in interfaceXMLString
- Overrides:
compareTo
in classXString
- Parameters:
xstr
- theString
to be compared.- Returns:
- the value
0
if the argument string is equal to this string; a value less than0
if this string is lexicographically less than the string argument; and a value greater than0
if this string is lexicographically greater than the string argument. - Throws:
NullPointerException
- ifanotherString
isnull
.
-
compareToIgnoreCase
Compares two strings lexicographically, ignoring case considerations. This method returns an integer whose sign is that ofthis.toUpperCase().toLowerCase().compareTo( str.toUpperCase().toLowerCase())
.Note that this method does not take locale into account, and will result in an unsatisfactory ordering for certain locales. The java.text package provides collators to allow locale-sensitive ordering.
- Specified by:
compareToIgnoreCase
in interfaceXMLString
- Overrides:
compareToIgnoreCase
in classXString
- Parameters:
xstr
- theString
to be compared.- Returns:
- a negative integer, zero, or a positive integer as the the specified String is greater than, equal to, or less than this String, ignoring case considerations.
- Since:
- 1.2
- See Also:
-
hashCode
public int hashCode()Returns a hashcode for this string. The hashcode for aString
object is computed as
usings[0]*31^(n-1) + s[1]*31^(n-2) + ... + s[n-1]
int
arithmetic, wheres[i]
is the ith character of the string,n
is the length of the string, and^
indicates exponentiation. (The hash value of the empty string is zero.) -
startsWith
Tests if this string starts with the specified prefix beginning a specified index.- Specified by:
startsWith
in interfaceXMLString
- Overrides:
startsWith
in classXString
- Parameters:
prefix
- the prefix.toffset
- where to begin looking in the string.- Returns:
true
if the character sequence represented by the argument is a prefix of the substring of this object starting at indextoffset
;false
otherwise. The result isfalse
iftoffset
is negative or greater than the length of thisString
object; otherwise the result is the same as the result of the expressionthis.subString(toffset).startsWith(prefix)
- Throws:
NullPointerException
- ifprefix
isnull
.
-
startsWith
Tests if this string starts with the specified prefix.- Specified by:
startsWith
in interfaceXMLString
- Overrides:
startsWith
in classXString
- Parameters:
prefix
- the prefix.- Returns:
true
if the character sequence represented by the argument is a prefix of the character sequence represented by this string;false
otherwise. Note also thattrue
will be returned if the argument is an empty string or is equal to thisString
object as determined by theequals(Object)
method.- Throws:
NullPointerException
- ifprefix
isnull
.- Since:
- JDK1. 0
-
indexOf
public int indexOf(int ch) Returns the index within this string of the first occurrence of the specified character. If a character with valuech
occurs in the character sequence represented by thisString
object, then the index of the first such occurrence is returned -- that is, the smallest value k such that:
isthis.charAt(k) == ch
true
. If no such character occurs in this string, then-1
is returned. -
indexOf
public int indexOf(int ch, int fromIndex) Returns the index within this string of the first occurrence of the specified character, starting the search at the specified index.If a character with value
ch
occurs in the character sequence represented by thisString
object at an index no smaller thanfromIndex
, then the index of the first such occurrence is returned--that is, the smallest value k such that:
is true. If no such character occurs in this string at or after position(this.charAt(k) == ch) invalid input: '&'invalid input: '&' (k >= fromIndex)
fromIndex
, then-1
is returned.There is no restriction on the value of
fromIndex
. If it is negative, it has the same effect as if it were zero: this entire string may be searched. If it is greater than the length of this string, it has the same effect as if it were equal to the length of this string:-1
is returned.- Specified by:
indexOf
in interfaceXMLString
- Overrides:
indexOf
in classXString
- Parameters:
ch
- a character.fromIndex
- the index to start the search from.- Returns:
- the index of the first occurrence of the character in the
character sequence represented by this object that is greater
than or equal to
fromIndex
, or-1
if the character does not occur.
-
substring
Returns a new string that is a substring of this string. The substring begins with the character at the specified index and extends to the end of this string.Examples:
"unhappy".substring(2) returns "happy" "Harbison".substring(3) returns "bison" "emptiness".substring(9) returns "" (an empty string)
- Specified by:
substring
in interfaceXMLString
- Overrides:
substring
in classXString
- Parameters:
beginIndex
- the beginning index, inclusive.- Returns:
- the specified substring.
- Throws:
IndexOutOfBoundsException
- ifbeginIndex
is negative or larger than the length of thisString
object.
-
substring
Returns a new string that is a substring of this string. The substring begins at the specifiedbeginIndex
and extends to the character at indexendIndex - 1
. Thus the length of the substring isendIndex-beginIndex
.- Specified by:
substring
in interfaceXMLString
- Overrides:
substring
in classXString
- Parameters:
beginIndex
- the beginning index, inclusive.endIndex
- the ending index, exclusive.- Returns:
- the specified substring.
- Throws:
IndexOutOfBoundsException
- if thebeginIndex
is negative, orendIndex
is larger than the length of thisString
object, orbeginIndex
is larger thanendIndex
.
-
concat
Concatenates the specified string to the end of this string.- Specified by:
concat
in interfaceXMLString
- Overrides:
concat
in classXString
- Parameters:
str
- theString
that is concatenated to the end of thisString
.- Returns:
- a string that represents the concatenation of this object's characters followed by the string argument's characters.
- Throws:
NullPointerException
- ifstr
isnull
.
-
trim
Removes white space from both ends of this string. -
fixWhiteSpace
Conditionally trim all leading and trailing whitespace in the specified String. All strings of white space are replaced by a single space character (#x20), except spaces after punctuation which receive double spaces if doublePunctuationSpaces is true. This function may be useful to a formatter, but to get first class results, the formatter should probably do it's own white space handling based on the semantics of the formatting object.- Specified by:
fixWhiteSpace
in interfaceXMLString
- Overrides:
fixWhiteSpace
in classXString
- Parameters:
trimHead
- Trim leading whitespace?trimTail
- Trim trailing whitespace?doublePunctuationSpaces
- Use double spaces for punctuation?- Returns:
- The trimmed string.
-
toDouble
public double toDouble()Convert a string to a double -- Allowed input is in fixed notation ddd.fff. %OPT% CHECK PERFORMANCE against generating a Java String and converting it to double. The advantage of running in native machine code -- perhaps even microcode, on some systems -- may more than make up for the cost of allocating and discarding the additional object. We need to benchmark this. %OPT% More importantly, we need to decide whether we _care_ about the performance of this operation. Does XString.toDouble constitute any measurable percentage of our typical runtime? I suspect not!
-