Class XString
- java.lang.Object
-
- org.apache.xpath.Expression
-
- org.apache.xpath.objects.XObject
-
- org.apache.xpath.objects.XString
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,javax.xml.transform.SourceLocator
,XMLString
,ExpressionNode
,XPathVisitable
- Direct Known Subclasses:
XStringForChars
,XStringForFSB
public class XString extends XObject implements XMLString
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
Fields Modifier and Type Field Description 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
Constructors Constructor Description XString(java.lang.String val)
Construct a XNodeSet object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
bool()
Cast result object to a boolean.void
callVisitors(ExpressionOwner owner, XPathVisitor visitor)
This will traverse the heararchy, calling the visitor for each member.char
charAt(int index)
Returns the character at the specified index.int
compareTo(XMLString xstr)
Compares two strings lexicographically.int
compareToIgnoreCase(XMLString str)
Compares two strings lexicographically, ignoring case considerations.XMLString
concat(java.lang.String str)
Concatenates the specified string to the end of this string.void
dispatchAsComment(org.xml.sax.ext.LexicalHandler lh)
Directly call the comment method on the passed LexicalHandler for the string-value.void
dispatchCharactersEvents(org.xml.sax.ContentHandler ch)
Directly call the characters method on the passed ContentHandler for the string-value.boolean
endsWith(java.lang.String suffix)
Tests if this string ends with the specified suffix.boolean
equals(java.lang.Object obj2)
Compares this string to the specified object.boolean
equals(java.lang.String obj2)
Compares this string to the specifiedString
.boolean
equals(XMLString obj2)
Compares this string to the specified object.boolean
equals(XObject obj2)
Tell if two objects are functionally equal.boolean
equalsIgnoreCase(java.lang.String anotherString)
Compares thisString
to anotherString
, ignoring case considerations.XMLString
fixWhiteSpace(boolean trimHead, boolean trimTail, boolean doublePunctuationSpaces)
Conditionally trim all leading and trailing whitespace in the specified String.void
getChars(int srcBegin, int srcEnd, char[] dst, int dstBegin)
Copies characters from this string into the destination character array.int
getType()
Tell that this is a CLASS_STRING.java.lang.String
getTypeString()
Given a request type, return the equivalent string.int
hashCode()
Returns a hashcode for this string.boolean
hasString()
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
indexOf(java.lang.String str)
Returns the index within this string of the first occurrence of the specified substring.int
indexOf(java.lang.String str, int fromIndex)
Returns the index within this string of the first occurrence of the specified substring, starting at the specified index.int
indexOf(XMLString str)
Returns the index within this string of the first occurrence of the specified substring.int
lastIndexOf(int ch)
Returns the index within this string of the last occurrence of the specified character.int
lastIndexOf(int ch, int fromIndex)
Returns the index within this string of the last occurrence of the specified character, searching backward starting at the specified index.int
lastIndexOf(java.lang.String str)
Returns the index within this string of the rightmost occurrence of the specified substring.int
lastIndexOf(java.lang.String str, int fromIndex)
Returns the index within this string of the last occurrence of the specified substring.int
length()
Returns the length of this string.double
num()
Cast result object to a number.int
rtf(XPathContext support)
Cast result object to a result tree fragment.boolean
startsWith(java.lang.String prefix)
Tests if this string starts with the specified prefix.boolean
startsWith(java.lang.String prefix, int toffset)
Tests if this string starts with the specified prefix beginning a specified index.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.java.lang.String
str()
Cast result object to a string.XMLString
substring(int beginIndex)
Returns a new string that is a substring of this string.XMLString
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.XMLString
toLowerCase()
Converts all of the characters in thisString
to lower case using the rules of the default locale, which is returned byLocale.getDefault
.XMLString
toLowerCase(java.util.Locale locale)
Converts all of the characters in thisString
to lower case using the rules of the givenLocale
.XMLString
toUpperCase()
Converts all of the characters in thisString
to upper case using the rules of the default locale, which is returned byLocale.getDefault
.XMLString
toUpperCase(java.util.Locale locale)
Converts all of the characters in thisString
to upper case using the rules of the given locale.XMLString
trim()
Removes white space from both ends of this string.XMLString
xstr()
Cast result object to a string.-
Methods inherited from class org.apache.xpath.objects.XObject
allowDetachToRelease, appendToFsb, boolWithSideEffects, castToType, create, create, deepEquals, destruct, detach, execute, fixupVariables, getFresh, greaterThan, greaterThanOrEqual, iter, lessThan, lessThanOrEqual, mutableNodeset, nodelist, nodeset, notEquals, numWithSideEffects, object, 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
-
-
-
-
Field Detail
-
EMPTYSTRING
public static final XString EMPTYSTRING
Empty string XString object
-
-
Method Detail
-
getType
public int getType()
Tell that this is a CLASS_STRING.
-
getTypeString
public java.lang.String getTypeString()
Given a request type, return the equivalent string. For diagnostic purposes.- Overrides:
getTypeString
in classXObject
- Returns:
- type string "#STRING"
-
hasString
public boolean hasString()
Tell if this object contains a java String object.
-
num
public double num()
Cast result object to a number.
-
toDouble
public double toDouble()
Convert a string to a double -- Allowed input is in fixed notation ddd.fff.
-
bool
public boolean bool()
Cast result object to a boolean.
-
xstr
public XMLString xstr()
Cast result object to a string.
-
str
public java.lang.String str()
Cast result object to a string.
-
rtf
public int rtf(XPathContext support)
Cast result object to a result tree fragment.
-
dispatchCharactersEvents
public void dispatchCharactersEvents(org.xml.sax.ContentHandler ch) throws org.xml.sax.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.- Specified by:
dispatchCharactersEvents
in interfaceXMLString
- Overrides:
dispatchCharactersEvents
in classXObject
- Parameters:
ch
- A non-null reference to a ContentHandler.- Throws:
org.xml.sax.SAXException
-
dispatchAsComment
public void dispatchAsComment(org.xml.sax.ext.LexicalHandler lh) throws org.xml.sax.SAXException
Directly call the comment method on the passed LexicalHandler for the string-value.- Specified by:
dispatchAsComment
in interfaceXMLString
- Parameters:
lh
- A non-null reference to a LexicalHandler.- Throws:
org.xml.sax.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
- 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 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
- 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 thansrcEnd
srcEnd
is greater than the length of this stringdstBegin
is negativedstBegin+(srcEnd-srcBegin)
is larger thandst.length
java.lang.NullPointerException
- ifdst
isnull
-
equals
public boolean equals(XObject obj2)
Tell if two objects are functionally equal.
-
equals
public boolean equals(java.lang.String obj2)
Compares this string to the specifiedString
. 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
public boolean equals(XMLString obj2)
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
public boolean equals(java.lang.Object obj2)
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
public boolean equalsIgnoreCase(java.lang.String anotherString)
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
- 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:
equals(Object)
,Character.toLowerCase(char)
,Character.toUpperCase(char)
-
compareTo
public int compareTo(XMLString xstr)
Compares two strings lexicographically.- Specified by:
compareTo
in interfaceXMLString
- 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:
java.lang.NullPointerException
- ifanotherString
isnull
.
-
compareToIgnoreCase
public int compareToIgnoreCase(XMLString str)
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
- Parameters:
str
- 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:
Collator.compare(String, String)
-
startsWith
public boolean startsWith(java.lang.String prefix, int toffset)
Tests if this string starts with the specified prefix beginning a specified index.- Specified by:
startsWith
in interfaceXMLString
- 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:
java.lang.NullPointerException
- ifprefix
isnull
.
-
startsWith
public boolean startsWith(java.lang.String prefix)
Tests if this string starts with the specified prefix.- Specified by:
startsWith
in interfaceXMLString
- 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:
java.lang.NullPointerException
- ifprefix
isnull
.
-
startsWith
public boolean startsWith(XMLString prefix, int toffset)
Tests if this string starts with the specified prefix beginning a specified index.- Specified by:
startsWith
in interfaceXMLString
- 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:
java.lang.NullPointerException
- ifprefix
isnull
.
-
startsWith
public boolean startsWith(XMLString prefix)
Tests if this string starts with the specified prefix.- Specified by:
startsWith
in interfaceXMLString
- 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:
java.lang.NullPointerException
- ifprefix
isnull
.
-
endsWith
public boolean endsWith(java.lang.String suffix)
Tests if this string ends with the specified suffix.- Specified by:
endsWith
in interfaceXMLString
- Parameters:
suffix
- the suffix.- Returns:
true
if the character sequence represented by the argument is a suffix of the character sequence represented by this object;false
otherwise. Note that the result will betrue
if the argument is the empty string or is equal to thisString
object as determined by theequals(Object)
method.- Throws:
java.lang.NullPointerException
- ifsuffix
isnull
.
-
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.)
-
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) && (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
- 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.
-
lastIndexOf
public int lastIndexOf(int ch)
Returns the index within this string of the last occurrence of the specified character. That is, the index returned is the largest value k such that:
is true. The String is searched backwards starting at the last character.this.charAt(k) == ch
- Specified by:
lastIndexOf
in interfaceXMLString
- Parameters:
ch
- a character.- Returns:
- the index of the last occurrence of the character in the
character sequence represented by this object, or
-1
if the character does not occur.
-
lastIndexOf
public int lastIndexOf(int ch, int fromIndex)
Returns the index within this string of the last occurrence of the specified character, searching backward starting at the specified index. That is, the index returned is the largest value k such that:
is true.this.charAt(k) == ch) && (k <= fromIndex)
- Specified by:
lastIndexOf
in interfaceXMLString
- Parameters:
ch
- a character.fromIndex
- the index to start the search from. There is no restriction on the value offromIndex
. If it is greater than or equal to the length of this string, it has the same effect as if it were equal to one less than the length of this string: this entire string may be searched. If it is negative, it has the same effect as if it were -1: -1 is returned.- Returns:
- the index of the last occurrence of the character in the
character sequence represented by this object that is less
than or equal to
fromIndex
, or-1
if the character does not occur before that point.
-
indexOf
public int indexOf(java.lang.String str)
Returns the index within this string of the first occurrence of the specified substring. The integer returned is the smallest value k such that:
isthis.startsWith(str, k)
true
.- Specified by:
indexOf
in interfaceXMLString
- Parameters:
str
- any string.- Returns:
- if the string argument occurs as a substring within this
object, then the index of the first character of the first
such substring is returned; if it does not occur as a
substring,
-1
is returned. - Throws:
java.lang.NullPointerException
- ifstr
isnull
.
-
indexOf
public int indexOf(XMLString str)
Returns the index within this string of the first occurrence of the specified substring. The integer returned is the smallest value k such that:
isthis.startsWith(str, k)
true
.- Specified by:
indexOf
in interfaceXMLString
- Parameters:
str
- any string.- Returns:
- if the string argument occurs as a substring within this
object, then the index of the first character of the first
such substring is returned; if it does not occur as a
substring,
-1
is returned. - Throws:
java.lang.NullPointerException
- ifstr
isnull
.
-
indexOf
public int indexOf(java.lang.String str, int fromIndex)
Returns the index within this string of the first occurrence of the specified substring, starting at the specified index. The integer returned is the smallest value k such that:
isthis.startsWith(str, k) && (k >= fromIndex)
true
.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
- Parameters:
str
- the substring to search for.fromIndex
- the index to start the search from.- Returns:
- If the string argument occurs as a substring within this
object at a starting index no smaller than
fromIndex
, then the index of the first character of the first such substring is returned. If it does not occur as a substring starting atfromIndex
or beyond,-1
is returned. - Throws:
java.lang.NullPointerException
- ifstr
isnull
-
lastIndexOf
public int lastIndexOf(java.lang.String str)
Returns the index within this string of the rightmost occurrence of the specified substring. The rightmost empty string "" is considered to occur at the index valuethis.length()
. The returned index is the largest value k such that
is true.this.startsWith(str, k)
- Specified by:
lastIndexOf
in interfaceXMLString
- Parameters:
str
- the substring to search for.- Returns:
- if the string argument occurs one or more times as a substring
within this object, then the index of the first character of
the last such substring is returned. If it does not occur as
a substring,
-1
is returned. - Throws:
java.lang.NullPointerException
- ifstr
isnull
.
-
lastIndexOf
public int lastIndexOf(java.lang.String str, int fromIndex)
Returns the index within this string of the last occurrence of the specified substring.- Specified by:
lastIndexOf
in interfaceXMLString
- Parameters:
str
- the substring to search for.fromIndex
- the index to start the search from. There is no restriction on the value of fromIndex. 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: this entire string may be searched. If it is negative, it has the same effect as if it were -1: -1 is returned.- Returns:
- If the string argument occurs one or more times as a substring
within this object at a starting index no greater than
fromIndex
, then the index of the first character of the last such substring is returned. If it does not occur as a substring starting atfromIndex
or earlier,-1
is returned. - Throws:
java.lang.NullPointerException
- ifstr
isnull
.
-
substring
public XMLString substring(int beginIndex)
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)
-
substring
public XMLString substring(int beginIndex, int endIndex)
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
- Parameters:
beginIndex
- the beginning index, inclusive.endIndex
- the ending index, exclusive.- Returns:
- the specified substring.
- Throws:
java.lang.IndexOutOfBoundsException
- if thebeginIndex
is negative, orendIndex
is larger than the length of thisString
object, orbeginIndex
is larger thanendIndex
.
-
concat
public XMLString concat(java.lang.String str)
Concatenates the specified string to the end of this string.- Specified by:
concat
in interfaceXMLString
- 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:
java.lang.NullPointerException
- ifstr
isnull
.
-
toLowerCase
public XMLString toLowerCase(java.util.Locale locale)
Converts all of the characters in thisString
to lower case using the rules of the givenLocale
.- Specified by:
toLowerCase
in interfaceXMLString
- Parameters:
locale
- use the case transformation rules for this locale- Returns:
- the String, converted to lowercase.
- See Also:
Character.toLowerCase(char)
,String.toUpperCase(Locale)
-
toLowerCase
public XMLString toLowerCase()
Converts all of the characters in thisString
to lower case using the rules of the default locale, which is returned byLocale.getDefault
.- Specified by:
toLowerCase
in interfaceXMLString
- Returns:
- the string, converted to lowercase.
- See Also:
Character.toLowerCase(char)
,String.toLowerCase(Locale)
-
toUpperCase
public XMLString toUpperCase(java.util.Locale locale)
Converts all of the characters in thisString
to upper case using the rules of the given locale.- Specified by:
toUpperCase
in interfaceXMLString
- Parameters:
locale
- use the case transformation rules for this locale- Returns:
- the String, converted to uppercase.
- See Also:
Character.toUpperCase(char)
,String.toLowerCase(Locale)
-
toUpperCase
public XMLString toUpperCase()
Converts all of the characters in thisString
to upper case using the rules of the default locale, which is returned byLocale.getDefault
.If no character in this string has a different uppercase version, based on calling the
toUpperCase
method defined byCharacter
, then the original string is returned.Otherwise, this method creates a new
String
object representing a character sequence identical in length to the character sequence represented by thisString
object and with every character equal to the result of applying the methodCharacter.toUpperCase
to the corresponding character of thisString
object.Examples:
"Fahrvergnügen".toUpperCase() returns "FAHRVERGNÜGEN" "Visit Ljubinje!".toUpperCase() returns "VISIT LJUBINJE!"
- Specified by:
toUpperCase
in interfaceXMLString
- Returns:
- the string, converted to uppercase.
- See Also:
Character.toUpperCase(char)
,String.toUpperCase(Locale)
-
trim
public XMLString trim()
Removes white space from both ends of this string.
-
fixWhiteSpace
public XMLString fixWhiteSpace(boolean trimHead, boolean trimTail, boolean doublePunctuationSpaces)
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
- Parameters:
trimHead
- Trim leading whitespace?trimTail
- Trim trailing whitespace?doublePunctuationSpaces
- Use double spaces for punctuation?- Returns:
- The trimmed string.
-
callVisitors
public void callVisitors(ExpressionOwner owner, XPathVisitor visitor)
Description copied from interface:XPathVisitable
This will traverse the heararchy, calling the visitor for each member. If the called visitor method returns false, the subtree should not be called.- Specified by:
callVisitors
in interfaceXPathVisitable
- Overrides:
callVisitors
in classXObject
- Parameters:
owner
- The owner of the visitor, where that path may be rewritten if needed.visitor
- The visitor whose appropriate method will be called.- See Also:
XPathVisitable.callVisitors(ExpressionOwner, XPathVisitor)
-
-