Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.xml.utils.XMLStringDefault
Constructor Summary | |
|
Method Summary | |
char |
|
int | |
int |
|
XMLString |
|
void |
|
void |
|
boolean |
|
boolean |
|
boolean |
|
boolean | |
boolean |
|
XMLString |
|
void |
|
boolean |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int | |
int |
|
int |
|
int |
|
int |
|
int |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
XMLString |
|
XMLString |
|
double |
|
XMLString |
|
XMLString |
|
String |
|
XMLString |
|
XMLString |
|
XMLString |
|
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.
- Parameters:
index
- the index of the character.
- Returns:
- the character at the specified index of this string. The first character is at index
0
.
public int compareTo(XMLString anotherString)
Compares two strings lexicographically.
- Parameters:
anotherString
- 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.
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 interface XMLString
- 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:
java.text.Collator.compare(String, String)
public XMLString concat(String str)
Concatenates the specified string to the end of this string.
- 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.
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 interface XMLString
- Parameters:
lh
- A non-null reference to a LexicalHandler.
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 interface XMLString
- Parameters:
ch
- A non-null reference to a ContentHandler.
public boolean endsWith(String suffix)
Tests if this string ends with the specified suffix.
- 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.
public boolean equals(Object anObject)
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.
- Parameters:
anObject
- the object to compare thisString
against.
- Returns:
true
if theString
are equal;false
otherwise.
- See Also:
java.lang.String.compareTo(java.lang.String)
,java.lang.String.equalsIgnoreCase(java.lang.String)
public boolean equals(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.
- Parameters:
obj2
- the object to compare thisString
against.
- Returns:
true
if theString
s are equal;false
otherwise.
- See Also:
java.lang.String.compareTo(java.lang.String)
,java.lang.String.equalsIgnoreCase(java.lang.String)
public boolean equals(XMLString anObject)
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.
- Parameters:
anObject
- the object to compare thisString
against.
- Returns:
true
if theString
are equal;false
otherwise.
- See Also:
java.lang.String.compareTo(java.lang.String)
,java.lang.String.equalsIgnoreCase(java.lang.String)
public boolean equalsIgnoreCase(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 interface XMLString
- 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)
,java.lang.Character.toLowerCase(char)
,java.lang.Character.toUpperCase(char)
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 interface XMLString
- Parameters:
trimHead
- Trim leading whitespace?trimTail
- Trim trailing whitespace?doublePunctuationSpaces
- Use double spaces for punctuation?
- Returns:
- The trimmed string.
public void getChars(int srcBegin, int srcEnd, dst[] , int dstBegin)
Copies characters from this string into the destination character array.
- Parameters:
srcBegin
- index of the first character in the string to copy.srcEnd
- index after the last character in the string to copy.dstBegin
- the start offset in the destination array.
public boolean hasString()
Tell if this object contains a java String object.
- Returns:
- true if this XMLString can return a string without creating one.
public int hashCode()
Returns a hashcode for this string. The hashcode for aString
object is computed asusings[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.)
- Returns:
- a hash code value for this object.
public int indexOf(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
.
- 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.
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. The integer returned is the smallest value k such that:isthis.startsWith(str, k) && (k >= fromIndex)true
. There is no restriction on the value offromIndex
. 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 atfromIndex
or beyond,-1
is returned.
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) == chtrue
. 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.
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 valuech
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 offromIndex
. 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.
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
.
- 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.
public int lastIndexOf(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 thatis true.this.startsWith(str, k)
- Specified by:
- lastIndexOf in interface XMLString
- 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.
public int lastIndexOf(String str, int fromIndex)
Returns the index within this string of the last occurrence of the specified substring.
- Specified by:
- lastIndexOf in interface XMLString
- 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.
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 interface XMLString
- 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.
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 interface XMLString
- 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.
public int length()
Returns the length of this string.
- Returns:
- the length of the sequence of characters represented by this object.
public boolean startsWith(String prefix)
Tests if this string starts with the specified prefix.
- Specified by:
- startsWith in interface XMLString
- 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.
- Since:
- JDK1. 0
public boolean startsWith(String prefix, int toffset)
Tests if this string starts with the specified prefix beginning a specified index.
- Specified by:
- startsWith in interface XMLString
- 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)
public boolean startsWith(XMLString prefix)
Tests if this string starts with the specified prefix.
- Specified by:
- startsWith in interface XMLString
- 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.
- Since:
- JDK1. 0
public boolean startsWith(XMLString prefix, int toffset)
Tests if this string starts with the specified prefix beginning a specified index.
- Specified by:
- startsWith in interface XMLString
- 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)
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)
- Parameters:
beginIndex
- the beginning index, inclusive.
- Returns:
- the specified 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
.
- Parameters:
beginIndex
- the beginning index, inclusive.endIndex
- the ending index, exclusive.
- Returns:
- the specified substring.
public double toDouble()
Convert a string to a double -- Allowed input is in fixed notation ddd.fff.
- Returns:
- A double value representation of the string, or return Double.NaN if the string can not be converted.
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 interface XMLString
- Returns:
- the string, converted to lowercase.
- See Also:
java.lang.Character.toLowerCase(char)
,java.lang.String.toLowerCase(Locale)
public XMLString toLowerCase(Locale locale)
Converts all of the characters in thisString
to lower case using the rules of the givenLocale
.
- Specified by:
- toLowerCase in interface XMLString
- 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)
public String toString()
This object (which is already a string!) is itself returned.
- Returns:
- the string itself.
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 thetoUpperCase
method defined byCharacter
, then the original string is returned. Otherwise, this method creates a newString
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 interface XMLString
- Returns:
- the string, converted to uppercase.
- See Also:
java.lang.Character.toUpperCase(char)
,java.lang.String.toUpperCase(Locale)
public XMLString toUpperCase(Locale locale)
Converts all of the characters in thisString
to upper case using the rules of the given locale.
- Specified by:
- toUpperCase in interface XMLString
- 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)
public XMLString trim()
Removes white space from both ends of this string. If thisString
object represents an empty character sequence, or the first and last characters of character sequence represented by thisString
object both have codes greater than'\u0020'
(the space character), then a reference to thisString
object is returned. Otherwise, if there is no character with a code greater than'\u0020'
in the string, then a newString
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 newString
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 ofthis.substring(k, m+1)
. This method may be used to trimwhitespace
from the beginning and end of a string; in fact, it trims all ASCII control characters as well.
- Returns:
- this string, with white space removed from the front and end.