org.apache.xpath.objects
public class XString extends XObject implements XMLString
UNKNOWN: general
Field Summary | |
---|---|
static XString | EMPTYSTRING Empty string XString object |
Constructor Summary | |
---|---|
XString(String val)
Construct a XNodeSet object.
|
Method Summary | |
---|---|
boolean | bool()
Cast result object to a boolean.
|
void | callVisitors(ExpressionOwner owner, XPathVisitor visitor) |
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(String str)
Concatenates the specified string to the end of this string.
|
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. |
boolean | endsWith(String suffix)
Tests if this string ends with the specified suffix.
|
boolean | equals(XObject obj2)
Tell if two objects are functionally equal.
|
boolean | equals(String obj2)
Compares this string to the specified String .
|
boolean | equals(XMLString obj2)
Compares this string to the specified object.
|
boolean | equals(Object obj2)
Compares this string to the specified object.
|
boolean | equalsIgnoreCase(String anotherString)
Compares this String to another String ,
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.
|
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(String str)
Returns the index within this string of the first occurrence of the
specified substring. |
int | indexOf(XMLString str)
Returns the index within this string of the first occurrence of the
specified substring. |
int | indexOf(String str, int fromIndex)
Returns the index within this string of the first occurrence of the
specified substring, starting at the specified index. |
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(String str)
Returns the index within this string of the rightmost occurrence
of the specified substring. |
int | lastIndexOf(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(String prefix, int toffset)
Tests if this string starts with the specified prefix beginning
a specified index.
|
boolean | startsWith(String 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.
|
boolean | startsWith(XMLString prefix)
Tests if this string starts with the specified prefix.
|
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(Locale locale)
Converts all of the characters in this String to lower
case using the rules of the given Locale .
|
XMLString | toLowerCase()
Converts all of the characters in this String to lower
case using the rules of the default locale, which is returned
by Locale.getDefault .
|
XMLString | toUpperCase(Locale locale)
Converts all of the characters in this String to upper
case using the rules of the given locale. |
XMLString | toUpperCase()
Converts all of the characters in this String to upper
case using the rules of the default locale, which is returned
by Locale.getDefault .
|
XMLString | trim()
Removes white space from both ends of this string.
|
XMLString | xstr()
Cast result object to a string.
|
Parameters: val String object this will wrap.
Returns: True if the length of this string object is greater than 0.
See Also: XPathVisitable
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: IndexOutOfBoundsException if the index
argument is negative or not less than the length of this
string.
Parameters: xstr the String
to be compared.
Returns: the value 0
if the argument string is equal to
this string; a value less than 0
if this string
is lexicographically less than the string argument; and a
value greater than 0
if this string is
lexicographically greater than the string argument.
Throws: java.lang.NullPointerException if anotherString
is null
.
this.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.
Parameters: str the String
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: java.text.Collator#compare(String, String)
Parameters: str the String
that is concatenated to the end
of this String
.
Returns: a string that represents the concatenation of this object's characters followed by the string argument's characters.
Throws: java.lang.NullPointerException if str
is
null
.
Parameters: lh A non-null reference to a LexicalHandler.
Throws: org.xml.sax.SAXException
Parameters: ch A non-null reference to a ContentHandler.
Throws: org.xml.sax.SAXException
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 be true
if the argument is the
empty string or is equal to this String
object
as determined by the equals method.
Throws: java.lang.NullPointerException if suffix
is
null
.
Parameters: obj2 Object to compare this to
Returns: true if the two objects are equal
Throws: javax.xml.transform.TransformerException
String
.
The result is true
if and only if the argument is not
null
and is a String
object that represents
the same sequence of characters as this object.
Parameters: obj2 the object to compare this String
against.
Returns: true
if the String
s are equal;
false
otherwise.
See Also: java.lang.String#compareTo(java.lang.String) java.lang.String#equalsIgnoreCase(java.lang.String)
true
if and only if the argument is not
null
and is a String
object that represents
the same sequence of characters as this object.
Parameters: obj2 the object to compare this String
against.
Returns: true
if the String
are equal;
false
otherwise.
See Also: java.lang.String#compareTo(java.lang.String) java.lang.String#equalsIgnoreCase(java.lang.String)
true
if and only if the argument is not
null
and is a String
object that represents
the same sequence of characters as this object.
Parameters: obj2 the object to compare this String
against.
Returns: true
if the String
are equal;
false
otherwise.
See Also: java.lang.String#compareTo(java.lang.String) java.lang.String#equalsIgnoreCase(java.lang.String)
String
to another String
,
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.
Parameters: anotherString the String
to compare this
String
against.
Returns: true
if the argument is not null
and the String
s are equal,
ignoring case; false
otherwise.
See Also: equals java.lang.Character#toLowerCase(char) java.lang.Character#toUpperCase(char)
Parameters: trimHead Trim leading whitespace? trimTail Trim trailing whitespace? doublePunctuationSpaces Use double spaces for punctuation?
Returns: The trimmed string.
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:
NullPointerException if 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
dst
is null
Returns: type CLASS_STRING
Returns: type string "#STRING"
String
object is computed as
usings[0]*31^(n-1) + s[1]*31^(n-2) + ... + s[n-1]
int
arithmetic, where s[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.)
Returns: a hash code value for this object.
Returns: true if this XMLString can return a string without creating one.
ch
occurs
in the character sequence represented by this String
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.
Parameters: ch a character.
Returns: the index of the first occurrence of the character in the
character sequence represented by this object, or
-1
if the character does not occur.
If a character with value ch
occurs in the character
sequence represented by this String
object at an index
no smaller than fromIndex
, 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.
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.
isthis.startsWith(str, k)
true
.
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 if str
is
null
.
isthis.startsWith(str, k)
true
.
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 if str
is
null
.
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.
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 at fromIndex
or beyond,
-1
is returned.
Throws: java.lang.NullPointerException if str
is
null
is true. The String is searched backwards starting at the last character.this.charAt(k) == ch
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.
is true.this.charAt(k) == ch) && (k <= fromIndex)
Parameters: ch a character. fromIndex the index to start the search from. There is no
restriction on the value of fromIndex
. 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.
this.length()
.
The returned index is the largest value k such that
is true.this.startsWith(str, k)
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 if str
is
null
.
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 at fromIndex
or earlier,
-1
is returned.
Throws: java.lang.NullPointerException if str
is
null
.
Returns: the length of the sequence of characters represented by this object.
Returns: 0.0 if this string is null, numeric value of this string or NaN
Parameters: support Xpath context to use for the conversion
Returns: A document fragment with this string as a child node
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 index toffset
; false
otherwise.
The result is false
if toffset
is
negative or greater than the length of this
String
object; otherwise the result is the same
as the result of the expression
this.subString(toffset).startsWith(prefix)
Throws: java.lang.NullPointerException if prefix
is
null
.
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 that true
will be returned if the
argument is an empty string or is equal to this
String
object as determined by the
equals method.
Throws: java.lang.NullPointerException if prefix
is
null
.
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 index toffset
; false
otherwise.
The result is false
if toffset
is
negative or greater than the length of this
String
object; otherwise the result is the same
as the result of the expression
this.subString(toffset).startsWith(prefix)
Throws: java.lang.NullPointerException if prefix
is
null
.
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 that true
will be returned if the
argument is an empty string or is equal to this
String
object as determined by the
equals method.
Throws: java.lang.NullPointerException if prefix
is
null
.
Returns: The string this wraps or the empty string if null
Examples:
"unhappy".substring(2) returns "happy" "Harbison".substring(3) returns "bison" "emptiness".substring(9) returns "" (an empty string)
Parameters: beginIndex the beginning index, inclusive.
Returns: the specified substring.
Throws: IndexOutOfBoundsException if
beginIndex
is negative or larger than the
length of this String
object.
beginIndex
and
extends to the character at index endIndex - 1
.
Thus the length of the substring is endIndex-beginIndex
.
Parameters: beginIndex the beginning index, inclusive. endIndex the ending index, exclusive.
Returns: the specified substring.
Throws: IndexOutOfBoundsException if the
beginIndex
is negative, or
endIndex
is larger than the length of
this String
object, or
beginIndex
is larger than
endIndex
.
Returns: A double value representation of the string, or return Double.NaN if the string can not be converted.
String
to lower
case using the rules of the given Locale
.
Parameters: locale use the case transformation rules for this locale
Returns: the String, converted to lowercase.
See Also: java.lang.Character#toLowerCase(char) java.lang.String#toUpperCase(Locale)
String
to lower
case using the rules of the default locale, which is returned
by Locale.getDefault
.
Returns: the string, converted to lowercase.
See Also: java.lang.Character#toLowerCase(char) java.lang.String#toLowerCase(Locale)
String
to upper
case using the rules of the given locale.Parameters: locale use the case transformation rules for this locale
Returns: the String, converted to uppercase.
See Also: java.lang.Character#toUpperCase(char) java.lang.String#toLowerCase(Locale)
String
to upper
case using the rules of the default locale, which is returned
by Locale.getDefault
.
If no character in this string has a different uppercase version,
based on calling the toUpperCase
method defined by
Character
, 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 this String
object and
with every character equal to the result of applying the method
Character.toUpperCase
to the corresponding character of
this String
object.
Examples:
"Fahrvergnügen".toUpperCase() returns "FAHRVERGNÜGEN" "Visit Ljubinje!".toUpperCase() returns "VISIT LJUBINJE!"
Returns: the string, converted to uppercase.
See Also: java.lang.Character#toUpperCase(char) java.lang.String#toUpperCase(Locale)
Returns: this string, with white space removed from the front and end.
Returns: The string this wraps or the empty string if null