|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface XMLString
This class is meant to be an interface to character strings, whether they
be java Strings or org.apache.xml.utils.FastStringBuffer
s, or
other character data. By using XMLString, character copies can be reduced
in the XML pipeline.
Method Summary | |
---|---|
char |
charAt(int index)
Returns the character at the specified index. |
int |
compareTo(XMLString anotherString)
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 anObject)
Compares this string to the specified object. |
boolean |
equals(java.lang.String anotherString)
Compares this string to the specified String . |
boolean |
equals(XMLString anObject)
Compares this string to the specified object. |
boolean |
equalsIgnoreCase(java.lang.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 |
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. |
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. |
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 this String to lower
case using the rules of the default locale, which is returned
by Locale.getDefault . |
XMLString |
toLowerCase(java.util.Locale locale)
Converts all of the characters in this String to lower
case using the rules of the given Locale . |
java.lang.String |
toString()
This object (which is already a string!) is itself returned. |
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 |
toUpperCase(java.util.Locale locale)
Converts all of the characters in this String to upper
case using the rules of the given locale. |
XMLString |
trim()
Removes white space from both ends of this string. |
Method Detail |
---|
void dispatchCharactersEvents(org.xml.sax.ContentHandler ch) throws org.xml.sax.SAXException
ch
- A non-null reference to a ContentHandler.
org.xml.sax.SAXException
void dispatchAsComment(org.xml.sax.ext.LexicalHandler lh) throws org.xml.sax.SAXException
lh
- A non-null reference to a LexicalHandler.
org.xml.sax.SAXException
XMLString fixWhiteSpace(boolean trimHead, boolean trimTail, boolean doublePunctuationSpaces)
trimHead
- Trim leading whitespace?trimTail
- Trim trailing whitespace?doublePunctuationSpaces
- Use double spaces for punctuation?
int length()
char charAt(int index)
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.
index
- the index of the character.
0
.
java.lang.IndexOutOfBoundsException
- if the index
argument is negative or not less than the length of this
string.void getChars(int srcBegin, int srcEnd, char[] dst, int dstBegin)
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.
java.lang.IndexOutOfBoundsException
- If any of the following
is true:
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
java.lang.NullPointerException
- if dst
is null
boolean equals(XMLString anObject)
true
if and only if the argument is not
null
and is an XMLString
object that represents
the same sequence of characters as this object.
anObject
- the object to compare this String
against.
true
if the String
are equal;
false
otherwise.String.compareTo(java.lang.String)
,
String.equalsIgnoreCase(java.lang.String)
boolean equals(java.lang.String anotherString)
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.
anotherString
- the object to compare this String
against.
true
if the String
s are equal;
false
otherwise.String.compareTo(java.lang.String)
,
String.equalsIgnoreCase(java.lang.String)
boolean equals(java.lang.Object anObject)
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.
equals
in class java.lang.Object
anObject
- the object to compare this String
against.
true
if the String
are equal;
false
otherwise.String.compareTo(java.lang.String)
,
String.equalsIgnoreCase(java.lang.String)
boolean equalsIgnoreCase(java.lang.String anotherString)
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.
anotherString
- the String
to compare this
String
against.
true
if the argument is not null
and the String
s are equal,
ignoring case; false
otherwise.equals(Object)
,
Character.toLowerCase(char)
,
Character.toUpperCase(char)
int compareTo(XMLString anotherString)
anotherString
- the String
to be compared.
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.
java.lang.NullPointerException
- if anotherString
is null
.int compareToIgnoreCase(XMLString str)
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.
str
- the String
to be compared.
Collator.compare(String, String)
boolean startsWith(java.lang.String prefix, int toffset)
prefix
- the prefix.toffset
- where to begin looking in the string.
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)
java.lang.NullPointerException
- if prefix
is
null
.boolean startsWith(XMLString prefix, int toffset)
prefix
- the prefix.toffset
- where to begin looking in the string.
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)
java.lang.NullPointerException
- if prefix
is
null
.boolean startsWith(java.lang.String prefix)
prefix
- the prefix.
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.
java.lang.NullPointerException
- if prefix
is
null
.boolean startsWith(XMLString prefix)
prefix
- the prefix.
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.
java.lang.NullPointerException
- if prefix
is
null
.boolean endsWith(java.lang.String suffix)
suffix
- the suffix.
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.
java.lang.NullPointerException
- if suffix
is
null
.int hashCode()
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.)
hashCode
in class java.lang.Object
int indexOf(int ch)
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.
ch
- a character.
-1
if the character does not occur.int indexOf(int ch, int fromIndex)
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.
ch
- a character.fromIndex
- the index to start the search from.
fromIndex
, or -1
if the character does not occur.int lastIndexOf(int ch)
is true. The String is searched backwards starting at the last character.this.charAt(k) == ch
ch
- a character.
-1
if the character does not occur.int lastIndexOf(int ch, int fromIndex)
is true.this.charAt(k) == ch) && (k <= fromIndex)
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.
fromIndex
, or -1
if the character does not occur before that point.int indexOf(java.lang.String str)
isthis.startsWith(str, k)
true
.
str
- any string.
-1
is returned.
java.lang.NullPointerException
- if str
is
null
.int indexOf(XMLString str)
isthis.startsWith(str, k)
true
.
str
- any string.
-1
is returned.
java.lang.NullPointerException
- if str
is
null
.int indexOf(java.lang.String str, int fromIndex)
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.
str
- the substring to search for.fromIndex
- the index to start the search from.
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.
java.lang.NullPointerException
- if str
is
null
int lastIndexOf(java.lang.String str)
this.length()
.
The returned index is the largest value k such that
is true.this.startsWith(str, k)
str
- the substring to search for.
-1
is returned.
java.lang.NullPointerException
- if str
is
null
.int lastIndexOf(java.lang.String str, int fromIndex)
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.
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.
java.lang.NullPointerException
- if str
is
null
.XMLString substring(int beginIndex)
Examples:
"unhappy".substring(2) returns "happy" "Harbison".substring(3) returns "bison" "emptiness".substring(9) returns "" (an empty string)
beginIndex
- the beginning index, inclusive.
java.lang.IndexOutOfBoundsException
- if
beginIndex
is negative or larger than the
length of this String
object.XMLString substring(int beginIndex, int endIndex)
beginIndex
and
extends to the character at index endIndex - 1
.
Thus the length of the substring is endIndex-beginIndex
.
beginIndex
- the beginning index, inclusive.endIndex
- the ending index, exclusive.
java.lang.IndexOutOfBoundsException
- if the
beginIndex
is negative, or
endIndex
is larger than the length of
this String
object, or
beginIndex
is larger than
endIndex
.XMLString concat(java.lang.String str)
str
- the String
that is concatenated to the end
of this String
.
java.lang.NullPointerException
- if str
is
null
.XMLString toLowerCase(java.util.Locale locale)
String
to lower
case using the rules of the given Locale
.
locale
- use the case transformation rules for this locale
Character.toLowerCase(char)
,
String.toUpperCase(Locale)
XMLString toLowerCase()
String
to lower
case using the rules of the default locale, which is returned
by Locale.getDefault
.
Character.toLowerCase(char)
,
String.toLowerCase(Locale)
XMLString toUpperCase(java.util.Locale locale)
String
to upper
case using the rules of the given locale.
locale
- use the case transformation rules for this locale
Character.toUpperCase(char)
,
String.toLowerCase(Locale)
XMLString toUpperCase()
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!"
Character.toUpperCase(char)
,
String.toUpperCase(Locale)
XMLString trim()
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
whitespace
from the beginning and end
of a string; in fact, it trims all ASCII control characters as well.
java.lang.String toString()
toString
in class java.lang.Object
boolean hasString()
double toDouble()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |