| org.apache.xml.utils.XMLString
All known Subclasses: org.apache.xpath.objects.XString, org.apache.xml.utils.XMLStringDefault,
| XMLString | | public interface XMLString (Code) | | This class is meant to be an interface to character strings, whether they
be java Strings or org.apache.xml.utils.FastStringBuffers, or
other character data. By using XMLString, character copies can be reduced
in the XML pipeline.
|
| Method Summary | |
| abstract public char | charAt(int index)
Returns the character at the specified index. | | abstract public int | compareTo(XMLString anotherString)
Compares two strings lexicographically.
Parameters:
anotherString - the String to be compared. | | abstract public int | compareToIgnoreCase(XMLString str)
Compares two strings lexicographically, ignoring case considerations.
This method returns an integer whose sign is that of
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. | | abstract public XMLString | concat(String str)
Concatenates the specified string to the end of this string.
Parameters:
str - the String that is concatenated to the endof this String. | | abstract public void | dispatchAsComment(org.xml.sax.ext.LexicalHandler lh)
Directly call the
comment method on the passed LexicalHandler for the
string-value. | | abstract public void | dispatchCharactersEvents(org.xml.sax.ContentHandler ch)
Directly call the
characters method on the passed ContentHandler for the
string-value. | | abstract public boolean | endsWith(String suffix)
Tests if this string ends with the specified suffix.
Parameters:
suffix - the suffix. | | abstract public boolean | equals(XMLString anObject)
Compares this string to the specified object.
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:
anObject - the object to compare this Stringagainst. | | abstract public boolean | equals(Object anObject)
Compares this string to the specified object.
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:
anObject - the object to compare this Stringagainst. | | abstract public boolean | equalsIgnoreCase(String anotherString)
Compares this String to another String,
ignoring case considerations. | | public XMLString | fixWhiteSpace(boolean trimHead, boolean trimTail, boolean doublePunctuationSpaces)
Conditionally trim all leading and trailing whitespace in the specified String. | | abstract public void | getChars(int srcBegin, int srcEnd, char dst, int dstBegin)
Copies characters from this string into the destination character
array. | | abstract public boolean | hasString()
Tell if this object contains a java String object. | | abstract public int | hashCode()
Returns a hashcode for this string. | | abstract public int | indexOf(int ch)
Returns the index within this string of the first occurrence of the
specified character. | | abstract 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 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:
(this.charAt(k) == ch) && (k >= fromIndex)
is true. | | abstract public int | indexOf(String str)
Returns the index within this string of the first occurrence of the
specified substring. | | abstract public int | indexOf(XMLString str)
Returns the index within this string of the first occurrence of the
specified substring. | | abstract public 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. | | abstract public int | lastIndexOf(int ch)
Returns the index within this string of the last occurrence of the
specified character. | | abstract 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. | | abstract public int | lastIndexOf(String str)
Returns the index within this string of the rightmost occurrence
of the specified substring. | | abstract public int | lastIndexOf(String str, int fromIndex)
Returns the index within this string of the last occurrence of
the specified substring.
Parameters:
str - the substring to search for.
Parameters:
fromIndex - the index to start the search from. | | abstract public int | length()
Returns the length of this string. | | abstract public boolean | startsWith(String prefix, int toffset)
Tests if this string starts with the specified prefix beginning
a specified index.
Parameters:
prefix - the prefix.
Parameters:
toffset - where to begin looking in the string. | | abstract public boolean | startsWith(XMLString prefix, int toffset)
Tests if this string starts with the specified prefix beginning
a specified index.
Parameters:
prefix - the prefix.
Parameters:
toffset - where to begin looking in the string. | | abstract public boolean | startsWith(String prefix)
Tests if this string starts with the specified prefix.
Parameters:
prefix - the prefix. | | abstract public boolean | startsWith(XMLString prefix)
Tests if this string starts with the specified prefix.
Parameters:
prefix - the prefix. | | abstract public XMLString | substring(int beginIndex)
Returns a new string that is a substring of this string. | | abstract public XMLString | substring(int beginIndex, int endIndex)
Returns a new string that is a substring of this string. | | public double | toDouble()
Convert a string to a double -- Allowed input is in fixed
notation ddd.fff. | | abstract public XMLString | toLowerCase(Locale locale)
Converts all of the characters in this String to lower
case using the rules of the given Locale. | | abstract public 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. | | abstract public String | toString()
This object (which is already a string!) is itself returned. | | abstract public XMLString | toUpperCase(Locale locale)
Converts all of the characters in this String to upper
case using the rules of the given locale. | | abstract public 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.
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. | | abstract public XMLString | trim()
Removes white space from both ends of this string.
If this String object represents an empty character
sequence, or the first and last characters of character sequence
represented by this String object both have codes
greater than '\u0020' (the space character), then a
reference to this String object is returned.
Otherwise, if there is no character with a code greater than
'\u0020' in the string, then a new
String object representing an empty string is created
and returned.
Otherwise, let k be the index of the first character in the
string whose code is greater than '\u0020', and let
m be the index of the last character in the string whose code
is greater than '\u0020'. |
| charAt | | abstract public char charAt(int index)(Code) | | 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. the character at the specified index of this string.The first character is at index 0.
exception:
IndexOutOfBoundsException - if the indexargument is negative or not less than the length of thisstring. |
| compareTo | | abstract public int compareTo(XMLString anotherString)(Code) | | Compares two strings lexicographically.
Parameters:
anotherString - the String to be compared. the value 0 if the argument string is equal tothis string; a value less than 0 if this stringis lexicographically less than the string argument; and avalue greater than 0 if this string islexicographically greater than the string argument.
exception:
java.lang.NullPointerException - if anotherStringis null. |
| compareToIgnoreCase | | abstract public int compareToIgnoreCase(XMLString str)(Code) | | Compares two strings lexicographically, ignoring case considerations.
This method returns an integer whose sign is that of
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. a negative integer, zero, or a positive integer as thethe specified String is greater than, equal to, or lessthan this String, ignoring case considerations.
See Also: java.text.Collator.compare(StringString)
since:
1.2 |
| concat | | abstract public XMLString concat(String str)(Code) | | Concatenates the specified string to the end of this string.
Parameters:
str - the String that is concatenated to the endof this String. a string that represents the concatenation of this object'scharacters followed by the string argument's characters.
exception:
java.lang.NullPointerException - if str isnull. |
| dispatchCharactersEvents | | abstract public void dispatchCharactersEvents(org.xml.sax.ContentHandler ch) throws org.xml.sax.SAXException(Code) | | 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:
org.xml.sax.SAXException - |
| endsWith | | abstract public boolean endsWith(String suffix)(Code) | | Tests if this string ends with the specified suffix.
Parameters:
suffix - the suffix. true if the character sequence represented by theargument is a suffix of the character sequence represented bythis object; false otherwise. Note that theresult will be true if the argument is theempty string or is equal to this String objectas determined by the XMLString.equals(Object) method.
exception:
java.lang.NullPointerException - if suffix isnull. |
| equalsIgnoreCase | | abstract public boolean equalsIgnoreCase(String anotherString)(Code) | | Compares this 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 thisString against. true if the argument is not nulland the Strings are equal,ignoring case; false otherwise.
See Also: XMLString.equals(Object)
See Also: java.lang.Character.toLowerCase(char)
See Also: java.lang.Character.toUpperCase(char) |
| fixWhiteSpace | | public XMLString fixWhiteSpace(boolean trimHead, boolean trimTail, boolean doublePunctuationSpaces)(Code) | | 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.
Parameters:
trimHead - Trim leading whitespace?
Parameters:
trimTail - Trim trailing whitespace?
Parameters:
doublePunctuationSpaces - Use double spaces for punctuation? The trimmed string. |
| getChars | | abstract public void getChars(int srcBegin, int srcEnd, char dst, int dstBegin)(Code) | | Copies characters from this string into the destination character
array.
Parameters:
srcBegin - index of the first character in the stringto copy.
Parameters:
srcEnd - index after the last character in the stringto copy.
Parameters:
dst - the destination array.
Parameters:
dstBegin - the start offset in the destination array.
exception:
IndexOutOfBoundsException - If any of the followingis true:srcBegin is negative.srcBegin is greater than srcEndsrcEnd is greater than the length of thisstringdstBegin is negativedstBegin+(srcEnd-srcBegin) is larger thandst.length
exception:
NullPointerException - if dst is null |
| hasString | | abstract public boolean hasString()(Code) | | Tell if this object contains a java String object.
true if this XMLString can return a string without creating one. |
| hashCode | | abstract public int hashCode()(Code) | | Returns a hashcode for this string. The hashcode for a
String object is computed as
s[0]*31^(n-1) + s[1]*31^(n-2) + ... + s[n-1]
using 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.)
a hash code value for this object. |
| indexOf | | abstract public int indexOf(int ch)(Code) | | Returns the index within this string of the first occurrence of the
specified character. If a character with value 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:
this.charAt(k) == ch
is true. If no such character occurs in this string,
then -1 is returned.
Parameters:
ch - a character. the index of the first occurrence of the character in thecharacter sequence represented by this object, or-1 if the character does not occur. |
| indexOf | | abstract public int indexOf(int ch, int fromIndex)(Code) | | 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 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:
(this.charAt(k) == ch) && (k >= fromIndex)
is true. If no such character occurs in this string at or after
position 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.
Parameters:
fromIndex - the index to start the search from. the index of the first occurrence of the character in thecharacter sequence represented by this object that is greaterthan or equal to fromIndex, or -1if the character does not occur. |
| indexOf | | abstract public int indexOf(String str)(Code) | | Returns the index within this string of the first occurrence of the
specified substring. The integer returned is the smallest value
k such that:
this.startsWith(str, k)
is true.
Parameters:
str - any string. if the string argument occurs as a substring within thisobject, then the index of the first character of the firstsuch substring is returned; if it does not occur as asubstring, -1 is returned.
exception:
java.lang.NullPointerException - if str isnull. |
| indexOf | | abstract public int indexOf(XMLString str)(Code) | | Returns the index within this string of the first occurrence of the
specified substring. The integer returned is the smallest value
k such that:
this.startsWith(str, k)
is true.
Parameters:
str - any string. if the string argument occurs as a substring within thisobject, then the index of the first character of the firstsuch substring is returned; if it does not occur as asubstring, -1 is returned.
exception:
java.lang.NullPointerException - if str isnull. |
| indexOf | | abstract public int indexOf(String str, int fromIndex)(Code) | | 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:
this.startsWith(str, k) && (k >= fromIndex)
is 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.
Parameters:
fromIndex - the index to start the search from. If the string argument occurs as a substring within thisobject at a starting index no smaller thanfromIndex, then the index of the first characterof the first such substring is returned. If it does not occuras a substring starting at fromIndex or beyond,-1 is returned.
exception:
java.lang.NullPointerException - if str isnull |
| lastIndexOf | | abstract public int lastIndexOf(int ch)(Code) | | 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:
this.charAt(k) == ch
is true.
The String is searched backwards starting at the last character.
Parameters:
ch - a character. the index of the last occurrence of the character in thecharacter sequence represented by this object, or-1 if the character does not occur. |
| lastIndexOf | | abstract public int lastIndexOf(int ch, int fromIndex)(Code) | | 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:
this.charAt(k) == ch) && (k <= fromIndex)
is true.
Parameters:
ch - a character.
Parameters:
fromIndex - the index to start the search from. There is norestriction on the value of fromIndex. If it isgreater than or equal to the length of this string, it hasthe same effect as if it were equal to one less than thelength 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. the index of the last occurrence of the character in thecharacter sequence represented by this object that is lessthan or equal to fromIndex, or -1if the character does not occur before that point. |
| lastIndexOf | | abstract public int lastIndexOf(String str)(Code) | | 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 this.length().
The returned index is the largest value k such that
this.startsWith(str, k)
is true.
Parameters:
str - the substring to search for. if the string argument occurs one or more times as a substringwithin this object, then the index of the first character ofthe last such substring is returned. If it does not occur asa substring, -1 is returned.
exception:
java.lang.NullPointerException - if str isnull. |
| lastIndexOf | | abstract public int lastIndexOf(String str, int fromIndex)(Code) | | Returns the index within this string of the last occurrence of
the specified substring.
Parameters:
str - the substring to search for.
Parameters:
fromIndex - the index to start the search from. There is norestriction on the value of fromIndex. If it is greater thanthe length of this string, it has the same effect as if itwere equal to the length of this string: this entire stringmay be searched. If it is negative, it has the same effectas if it were -1: -1 is returned. If the string argument occurs one or more times as a substringwithin this object at a starting index no greater thanfromIndex, then the index of the first character ofthe last such substring is returned. If it does not occur as asubstring starting at fromIndex or earlier,-1 is returned.
exception:
java.lang.NullPointerException - if str isnull. |
| length | | abstract public int length()(Code) | | Returns the length of this string.
the length of the sequence of characters represented by thisobject. |
| startsWith | | abstract public boolean startsWith(String prefix, int toffset)(Code) | | Tests if this string starts with the specified prefix beginning
a specified index.
Parameters:
prefix - the prefix.
Parameters:
toffset - where to begin looking in the string. true if the character sequence represented by theargument is a prefix of the substring of this object startingat index toffset; false otherwise.The result is false if toffset isnegative or greater than the length of thisString object; otherwise the result is the sameas the result of the expressionthis.subString(toffset).startsWith(prefix)
exception:
java.lang.NullPointerException - if prefix isnull. |
| startsWith | | abstract public boolean startsWith(XMLString prefix, int toffset)(Code) | | Tests if this string starts with the specified prefix beginning
a specified index.
Parameters:
prefix - the prefix.
Parameters:
toffset - where to begin looking in the string. true if the character sequence represented by theargument is a prefix of the substring of this object startingat index toffset; false otherwise.The result is false if toffset isnegative or greater than the length of thisString object; otherwise the result is the sameas the result of the expressionthis.subString(toffset).startsWith(prefix)
exception:
java.lang.NullPointerException - if prefix isnull. |
| startsWith | | abstract public boolean startsWith(String prefix)(Code) | | Tests if this string starts with the specified prefix.
Parameters:
prefix - the prefix. true if the character sequence represented by theargument is a prefix of the character sequence represented bythis string; false otherwise.Note also that true will be returned if theargument is an empty string or is equal to thisString object as determined by theXMLString.equals(Object) method.
exception:
java.lang.NullPointerException - if prefix isnull.
since:
JDK1. 0 |
| startsWith | | abstract public boolean startsWith(XMLString prefix)(Code) | | Tests if this string starts with the specified prefix.
Parameters:
prefix - the prefix. true if the character sequence represented by theargument is a prefix of the character sequence represented bythis string; false otherwise.Note also that true will be returned if theargument is an empty string or is equal to thisString object as determined by theXMLString.equals(Object) method.
exception:
java.lang.NullPointerException - if prefix isnull.
since:
JDK1. 0 |
| substring | | abstract public XMLString substring(int beginIndex)(Code) | | 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)
Parameters:
beginIndex - the beginning index, inclusive. the specified substring.
exception:
IndexOutOfBoundsException - ifbeginIndex is negative or larger than thelength of this String object. |
| substring | | abstract public XMLString substring(int beginIndex, int endIndex)(Code) | | Returns a new string that is a substring of this string. The
substring begins at the specified 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.
Parameters:
endIndex - the ending index, exclusive. the specified substring.
exception:
IndexOutOfBoundsException - if thebeginIndex is negative, orendIndex is larger than the length ofthis String object, orbeginIndex is larger thanendIndex. |
| toDouble | | public double toDouble()(Code) | | Convert a string to a double -- Allowed input is in fixed
notation ddd.fff.
A double value representation of the string, or return Double.NaN if the string can not be converted. |
| toString | | abstract public String toString()(Code) | | This object (which is already a string!) is itself returned.
the string itself. |
| toUpperCase | | abstract public XMLString toUpperCase()(Code) | | Converts all of the characters in this 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!"
the string, converted to uppercase.
See Also: java.lang.Character.toUpperCase(char)
See Also: java.lang.String.toUpperCase(Locale) |
| trim | | abstract public XMLString trim()(Code) | | Removes white space from both ends of this string.
If this String object represents an empty character
sequence, or the first and last characters of character sequence
represented by this String object both have codes
greater than '\u0020' (the space character), then a
reference to this String object is returned.
Otherwise, if there is no character with a code greater than
'\u0020' in the string, then a new
String object representing an empty string is created
and returned.
Otherwise, let k be the index of the first character in the
string whose code is greater than '\u0020', and let
m be the index of the last character in the string whose code
is greater than '\u0020'. A new String
object is created, representing the substring of this string that
begins with the character at index k and ends with the
character at index m-that is, the result of
this.substring(k, m+1).
This method may be used to trim
Character.isSpace(char) whitespace from the beginning and end
of a string; in fact, it trims all ASCII control characters as well.
this string, with white space removed from the front and end. |
|
|