| Modifier and Type | Field and Description |
|---|---|
| public static final XString | EMPTYSTRING
Empty string XString object |
| pack-priv static final long |
| Access | Constructor and Description |
|---|---|
| protected | |
| public |
| Modifier and Type | Method and Description |
|---|---|
| public boolean | Returns: True if the length of this string object is greater than 0.Overrides com. Cast result object to a boolean. |
| public void | callVisitors(ExpressionOwner owner, XPathVisitor visitor)
Overrides com. Implements com. This will traverse the heararchy, calling the visitor for each member. |
| public char | Returns: the character at the specified index of this string. The first character is at index0.the index of the character. index)Implements com. Returns the character at the specified index. |
| public int | Returns: the value0 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.the xstr)String to be compared.Implements com. Compares two strings lexicographically. |
| public int | 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.the str)String to be compared.Implements com. Compares two strings lexicographically, ignoring case considerations. |
| public XMLString | Returns: a string that represents the concatenation of this object's characters followed by the string argument's characters.the str)String that is concatenated to the end
of this String.Implements com. Concatenates the specified string to the end of this string. |
| public void | dispatchAsComment(LexicalHandler
A non-null reference to a LexicalHandler. lh)Implements com. Directly call the comment method on the passed LexicalHandler for the string-value. |
| public void | dispatchCharactersEvents(ContentHandler
A non-null reference to a ContentHandler. ch)Overrides com. Implements com. Directly call the characters method on the passed ContentHandler for the string-value. |
| public boolean | 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(Object) method.the suffix. suffix)Implements com. Tests if this string ends with the specified suffix. |
| public boolean | Returns: true if the two objects are equalObject to compare this to obj2)Overrides com. Tell if two objects are functionally equal. |
| public boolean | Returns: true if the Strings are equal;
false otherwise.the object to compare this obj2)String against.Implements com. Compares this string to the specified |
| public boolean | Returns: true if the String are equal;
false otherwise.the object to compare this obj2)String
against.Implements com. Compares this string to the specified object. |
| public boolean | Returns: true if the String are equal;
false otherwise.the object to compare this obj2)String
against.Overrides java. Implements com. Compares this string to the specified object. |
| public boolean | Returns: true if the argument is not null
and the Strings are equal,
ignoring case; false otherwise.the anotherString)String to compare this
String against.Implements com. Compares this |
| public XMLString | Returns: The trimmed string.Trim leading whitespace? trimHead, boolean Trim trailing whitespace? trimTail, boolean Use double spaces for punctuation? doublePunctuationSpaces)Implements com. Conditionally trim all leading and trailing whitespace in the specified String. |
| public void | getChars(int
index of the first character in the string
to copy. srcBegin, int index after the last character in the string
to copy. srcEnd, char[] the destination array. dst, int the start offset in the destination array. dstBegin)Implements com. Copies characters from this string into the destination character array. |
| public int | Returns: type CLASS_STRINGOverrides com. Tell that this is a CLASS_STRING. |
| public String | Returns: type string "#STRING"Overrides com. Given a request type, return the equivalent string. |
| public int | Returns: a hash code value for this object.Overrides java. Implements com. Returns a hashcode for this string. |
| public boolean | Returns: true if this XMLString can return a string without creating one.Implements com. Tell if this object contains a java String object. |
| public int | 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.a character. ch)Implements com. Returns the index within this string of the first occurrence of the specified character. |
| public int | Returns: the index of the first occurrence of the character in the character sequence represented by this object that is greater than or equal tofromIndex, or -1
if the character does not occur.a character. ch, int the index to start the search from. fromIndex)Implements com. Returns the index within this string of the first occurrence of the specified character, starting the search at the specified index. |
| public int | 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.any string. str)Implements com. Returns the index within this string of the first occurrence of the specified substring. |
| public int | 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.any string. str)Implements com. Returns the index within this string of the first occurrence of the specified substring. |
| public int | Returns: If the string argument occurs as a substring within this object at a starting index no smaller thanfromIndex, 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.the substring to search for. str, int the index to start the search from. fromIndex)Implements com. Returns the index within this string of the first occurrence of the specified substring, starting at the specified index. |
| private static boolean | Returns: =true if ch is XML whitespace; otherwise =false.Character to check as XML whitespace. ch)Returns whether the specified ch conforms to the XML 1.0 definition of whitespace. |
| public int | 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.a character. ch)Implements com. Returns the index within this string of the last occurrence of the specified character. |
| public int | Returns: the index of the last occurrence of the character in the character sequence represented by this object that is less than or equal tofromIndex, or -1
if the character does not occur before that point.a character. ch, int the index to start the search from. There is no
restriction on the value of fromIndex)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.Implements com. Returns the index within this string of the last occurrence of the specified character, searching backward starting at the specified index. |
| public int | 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.the substring to search for. str)Implements com. Returns the index within this string of the rightmost occurrence of the specified substring. |
| public int | Returns: If the string argument occurs one or more times as a substring within this object at a starting index no greater thanfromIndex, 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.the substring to search for. str, int 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. fromIndex)Implements com. Returns the index within this string of the last occurrence of the specified substring. |
| public int | Returns: the length of the sequence of characters represented by this object.Implements com. Returns the length of this string. |
| public double | Returns: 0.0 if this string is null, numeric value of this string or NaNOverrides com. Cast result object to a number. |
| public int | Returns: A document fragment with this string as a child nodeXpath context to use for the conversion support)Overrides com. Cast result object to a result tree fragment. |
| public boolean | 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)
the prefix. prefix, int where to begin looking in the string. toffset)Implements com. Tests if this string starts with the specified prefix beginning a specified index. |
| public boolean | 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(Object) method.the prefix. prefix)Implements com. Tests if this string starts with the specified prefix. |
| public boolean | 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)
the prefix. prefix, int where to begin looking in the string. toffset)Implements com. Tests if this string starts with the specified prefix beginning a specified index. |
| public boolean | 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(Object) method.the prefix. prefix)Implements com. Tests if this string starts with the specified prefix. |
| public String | Returns: The string this wraps or the empty string if nullOverrides com. Cast result object to a string. |
| public XMLString | Returns: the specified substring.the beginning index, inclusive. beginIndex)Implements com. Returns a new string that is a substring of this string. |
| public XMLString | Returns: the specified substring.the beginning index, inclusive. beginIndex, int the ending index, exclusive. endIndex)Implements com. Returns a new string that is a substring of this string. |
| public double | Returns: A double value representation of the string, or return Double.NaN if the string can not be converted.Implements com. Convert a string to a double -- Allowed input is in fixed notation ddd.fff. |
| public XMLString | Returns: the String, converted to lowercase.use the case transformation rules for this locale locale)Implements com. Converts all of the characters in this |
| public XMLString | Returns: the string, converted to lowercase.Implements com. Converts all of the characters in this |
| public XMLString | Returns: the String, converted to uppercase.use the case transformation rules for this locale locale)Implements com. Converts all of the characters in this |
| public XMLString | Returns: the string, converted to uppercase.Implements com. Converts all of the characters in this |
| public XMLString | Returns: this string, with white space removed from the front and end.Implements com. Removes white space from both ends of this string. |
| public XMLString | Returns: The string this wraps or the empty string if nullOverrides com. Cast result object to a string. |
| EMPTYSTRING | back to summary |
|---|---|
| public static final XString EMPTYSTRING Empty string XString object | |
| serialVersionUID | back to summary |
|---|---|
| pack-priv static final long serialVersionUID Hides com. | |
| XString | back to summary |
|---|---|
| protected XString(Object val) Construct a XString object. This constructor exists for derived classes.
| |
| XString | back to summary |
|---|---|
| public XString(String val) Construct a XNodeSet object.
| |
| bool | back to summary |
|---|---|
| public boolean bool() Overrides com. Cast result object to a boolean.
| |
| callVisitors | back to summary |
|---|---|
| public void callVisitors(ExpressionOwner owner, XPathVisitor visitor) Overrides com. Implements com. Doc from com. This will traverse the heararchy, calling the visitor for each member. If the called visitor method returns false, the subtree should not be called. | |
| charAt | back to summary |
|---|---|
| public char charAt(int index) Implements com. Returns the character at the specified index. An index ranges
from
| |
| compareTo | back to summary |
|---|---|
| public int compareTo(XMLString xstr) Implements com. Compares two strings lexicographically.
| |
| compareToIgnoreCase | back to summary |
|---|---|
| public int compareToIgnoreCase(XMLString str) Implements com. Compares two strings lexicographically, ignoring case considerations.
This method returns an integer whose sign is that of
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.
| |
| concat | back to summary |
|---|---|
| public XMLString concat(String str) Implements com. Concatenates the specified string to the end of this string.
| |
| dispatchAsComment | back to summary |
|---|---|
| public void dispatchAsComment(LexicalHandler lh) throws SAXException Implements com. Directly call the comment method on the passed LexicalHandler for the string-value.
| |
| dispatchCharactersEvents | back to summary |
|---|---|
| public void dispatchCharactersEvents(ContentHandler ch) throws SAXException Overrides com. Implements com. 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.
| |
| endsWith | back to summary |
|---|---|
| public boolean endsWith(String suffix) Implements com. Tests if this string ends with the specified suffix.
| |
| equals | back to summary |
|---|---|
| public boolean equals(XObject obj2) Overrides com. Tell if two objects are functionally equal.
| |
| equals | back to summary |
|---|---|
| public boolean equals(String obj2) Implements com. Compares this string to the specified
| |
| equals | back to summary |
|---|---|
| public boolean equals(XMLString obj2) Implements com. Compares this string to the specified object.
The result is
| |
| equals | back to summary |
|---|---|
| public boolean equals(Object obj2) Overrides java. Implements com. Compares this string to the specified object.
The result is
| |
| equalsIgnoreCase | back to summary |
|---|---|
| public boolean equalsIgnoreCase(String anotherString) Implements com. Compares this
| |
| fixWhiteSpace | back to summary |
|---|---|
| public XMLString fixWhiteSpace(boolean trimHead, boolean trimTail, boolean doublePunctuationSpaces) Implements com. 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.
| |
| getChars | back to summary |
|---|---|
| public void getChars(int srcBegin, int srcEnd, char[] dst, int dstBegin) Implements com. Copies characters from this string into the destination character array.
| |
| getType | back to summary |
|---|---|
| public int getType() Overrides com. Tell that this is a CLASS_STRING.
| |
| getTypeString | back to summary |
|---|---|
| public String getTypeString() Overrides com. Given a request type, return the equivalent string. For diagnostic purposes.
| |
| hashCode | back to summary |
|---|---|
| public int hashCode() Overrides java. Implements com. Returns a hashcode for this string. The hashcode for a
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.)
| |
| hasString | back to summary |
|---|---|
| public boolean hasString() Implements com. Tell if this object contains a java String object.
| |
| indexOf | back to summary |
|---|---|
| public int indexOf(int ch) Implements com. Returns the index within this string of the first occurrence of the
specified character. If a character with value isthis.charAt(k) == ch true. If no such character occurs in this string,
then -1 is returned.
| |
| indexOf | back to summary |
|---|---|
| public int indexOf(int ch, int fromIndex) Implements com. 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 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
| |
| indexOf | back to summary |
|---|---|
| public int indexOf(String str) Implements com. 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.
| |
| indexOf | back to summary |
|---|---|
| public int indexOf(XMLString str) Implements com. 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.
| |
| indexOf | back to summary |
|---|---|
| public int indexOf(String str, int fromIndex) Implements com. 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
| |
| isSpace | back to summary |
|---|---|
| private static boolean isSpace(char ch) Returns whether the specified ch conforms to the XML 1.0 definition
of whitespace. Refer to
the definition of
| |
| lastIndexOf | back to summary |
|---|---|
| public int lastIndexOf(int ch) Implements com. 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
| |
| lastIndexOf | back to summary |
|---|---|
| public int lastIndexOf(int ch, int fromIndex) Implements com. 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)
| |
| lastIndexOf | back to summary |
|---|---|
| public int lastIndexOf(String str) Implements com. 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 value is true.this.startsWith(str, k)
| |
| lastIndexOf | back to summary |
|---|---|
| public int lastIndexOf(String str, int fromIndex) Implements com. Returns the index within this string of the last occurrence of the specified substring.
| |
| length | back to summary |
|---|---|
| public int length() Implements com. Returns the length of this string.
| |
| num | back to summary |
|---|---|
| public double num() Overrides com. Cast result object to a number.
| |
| rtf | back to summary |
|---|---|
| public int rtf(XPathContext support) Overrides com. Cast result object to a result tree fragment.
| |
| startsWith | back to summary |
|---|---|
| public boolean startsWith(String prefix, int toffset) Implements com. Tests if this string starts with the specified prefix beginning a specified index.
| |
| startsWith | back to summary |
|---|---|
| public boolean startsWith(String prefix) Implements com. Tests if this string starts with the specified prefix.
| |
| startsWith | back to summary |
|---|---|
| public boolean startsWith(XMLString prefix, int toffset) Implements com. Tests if this string starts with the specified prefix beginning a specified index.
| |
| startsWith | back to summary |
|---|---|
| public boolean startsWith(XMLString prefix) Implements com. Tests if this string starts with the specified prefix.
| |
| str | back to summary |
|---|---|
| public String str() Overrides com. Cast result object to a string.
| |
| substring | back to summary |
|---|---|
| public XMLString substring(int beginIndex) Implements com. 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 | back to summary |
|---|---|
| public XMLString substring(int beginIndex, int endIndex) Implements com. Returns a new string that is a substring of this string. The
substring begins at the specified
| |
| toDouble | back to summary |
|---|---|
| public double toDouble() Implements com. Convert a string to a double -- Allowed input is in fixed notation ddd.fff.
| |
| toLowerCase | back to summary |
|---|---|
| public XMLString toLowerCase(Locale locale) Implements com. Converts all of the characters in this
| |
| toLowerCase | back to summary |
|---|---|
| public XMLString toLowerCase() Implements com. Converts all of the characters in this
| |
| toUpperCase | back to summary |
|---|---|
| public XMLString toUpperCase(Locale locale) Implements com. Converts all of the characters in this
| |
| toUpperCase | back to summary |
|---|---|
| public XMLString toUpperCase() Implements com. Converts all of the characters in this
If no character in this string has a different uppercase version,
based on calling the
Otherwise, this method creates a new Examples: "Fahrvergnügen".toUpperCase() returns "FAHRVERGNÜGEN" "Visit Ljubinje!".toUpperCase() returns "VISIT LJUBINJE!"
| |
| trim | back to summary |
|---|---|
| public XMLString trim() Implements com. Removes white space from both ends of this string.
| |
| xstr | back to summary |
|---|---|
| public XMLString xstr() Overrides com. Cast result object to a string.
| |
