Top Description Methods
com.sun.org.apache.xml.internal.utils

public Interface XMLString

Known Direct Implementers
com.sun.org.apache.xml.internal.utils.XMLStringDefault, com.sun.org.apache.xpath.internal.objects.XString
Imports
java.util.Locale

This class is meant to be an interface to character strings, whether they be java Strings or com.sun.org.apache.xml.internal.utils.FastStringBuffers, or other character data. By using XMLString, character copies can be reduced in the XML pipeline.

Method Summary

Modifier and TypeMethod and Description
public char

Returns:

the character at the specified index of this string. The first character is at index 0.
charAt
(int
the index of the character.
index
)

Returns the character at the specified index.

public int

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.
compareTo
(XMLString
the String to be compared.
anotherString
)

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.
compareToIgnoreCase
(XMLString
the String to be compared.
str
)

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.
concat
(String
the String that is concatenated to the end of this String.
str
)

Concatenates the specified string to the end of this string.

public void
dispatchAsComment(LexicalHandler
A non-null reference to a LexicalHandler.
lh
)

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
)

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.
endsWith
(String
the suffix.
suffix
)

Tests if this string ends with the specified suffix.

public boolean

Returns:

true if the String are equal; false otherwise.
equals
(XMLString
the object to compare this String against.
anObject
)

Compares this string to the specified object.

public boolean

Returns:

true if the Strings are equal; false otherwise.
equals
(String
the object to compare this String against.
anotherString
)

Compares this string to the specified String.

public boolean

Returns:

true if the String are equal; false otherwise.
equals
(Object
the object to compare this String against.
anObject
)

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.
equalsIgnoreCase
(String
the String to compare this String against.
anotherString
)

Compares this String to another String, ignoring case considerations.

public XMLString

Returns:

The trimmed string.
fixWhiteSpace
(boolean
Trim leading whitespace?
trimHead
,
boolean
Trim trailing whitespace?
trimTail
,
boolean
Use double spaces for punctuation?
doublePunctuationSpaces
)

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
)

Copies characters from this string into the destination character array.

public int

Returns:

a hash code value for this object.
hashCode
()

Returns a hashcode for this string.

public boolean

Returns:

true if this XMLString can return a string without creating one.
hasString
()

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.
indexOf
(int
a character.
ch
)

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 to fromIndex, or -1 if the character does not occur.
indexOf
(int
a character.
ch
,
int
the index to start the search from.
fromIndex
)

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.
indexOf
(String
any string.
str
)

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.
indexOf
(XMLString
any string.
str
)

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 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.
indexOf
(String
the substring to search for.
str
,
int
the index to start the search from.
fromIndex
)

Returns the index within this string of the first occurrence of the specified substring, starting at the specified index.

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.
lastIndexOf
(int
a character.
ch
)

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 to fromIndex, or -1 if the character does not occur before that point.
lastIndexOf
(int
a character.
ch
,
int
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
)

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.
lastIndexOf
(String
the substring to search for.
str
)

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 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.
lastIndexOf
(String
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
)

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.
length
()

Returns the length of this string.

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)
         
startsWith
(String
the prefix.
prefix
,
int
where to begin looking in the string.
toffset
)

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 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)
         
startsWith
(XMLString
the prefix.
prefix
,
int
where to begin looking in the string.
toffset
)

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.
startsWith
(String
the prefix.
prefix
)

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 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.
startsWith
(XMLString
the prefix.
prefix
)

Tests if this string starts with the specified prefix.

public XMLString

Returns:

the specified substring.
substring
(int
the beginning index, inclusive.
beginIndex
)

Returns a new string that is a substring of this string.

public XMLString

Returns:

the specified substring.
substring
(int
the beginning index, inclusive.
beginIndex
,
int
the ending index, exclusive.
endIndex
)

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.
toDouble
()

Convert a string to a double -- Allowed input is in fixed notation ddd.fff.

public XMLString

Returns:

the String, converted to lowercase.
toLowerCase
(Locale
use the case transformation rules for this locale
locale
)

Converts all of the characters in this String to lower case using the rules of the given Locale.

public XMLString

Returns:

the string, converted to lowercase.
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.

public String

Returns:

the string itself.
toString
()

This object (which is already a string!) is itself returned.

public XMLString

Returns:

the String, converted to uppercase.
toUpperCase
(Locale
use the case transformation rules for this locale
locale
)

Converts all of the characters in this String to upper case using the rules of the given locale.

public XMLString

Returns:

the string, converted to uppercase.
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.

public XMLString

Returns:

this string, with white space removed from the front and end.
trim
()

Removes white space from both ends of this string.

Method Detail

charAtback to summary
public char charAt(int index)

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:int

the index of the character.

Returns:char

the character at the specified index of this string. The first character is at index 0.

Exceptions
IndexOutOfBoundsException:
if the index argument is negative or not less than the length of this string.
compareToback to summary
public int compareTo(XMLString anotherString)

Compares two strings lexicographically.

Parameters
anotherString:XMLString

the String to be compared.

Returns:int

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.

Exceptions
NullPointerException:
if anotherString is null.
compareToIgnoreCaseback to summary
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:XMLString

the String to be compared.

Returns:int

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)
concatback to summary
public XMLString concat(String str)

Concatenates the specified string to the end of this string.

Parameters
str:String

the String that is concatenated to the end of this String.

Returns:XMLString

a string that represents the concatenation of this object's characters followed by the string argument's characters.

Exceptions
NullPointerException:
if str is null.
dispatchAsCommentback to summary
public void dispatchAsComment(LexicalHandler lh) throws SAXException

Directly call the comment method on the passed LexicalHandler for the string-value.

Parameters
lh:LexicalHandler

A non-null reference to a LexicalHandler.

dispatchCharactersEventsback to summary
public void dispatchCharactersEvents(ContentHandler ch) throws 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.

Parameters
ch:ContentHandler

A non-null reference to a ContentHandler.

endsWithback to summary
public boolean endsWith(String suffix)

Tests if this string ends with the specified suffix.

Parameters
suffix:String

the suffix.

Returns:boolean

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.

Exceptions
NullPointerException:
if suffix is null.
equalsback to summary
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 an XMLString object that represents the same sequence of characters as this object.

Parameters
anObject:XMLString

the object to compare this String against.

Returns:boolean

true if the String are equal; false otherwise.

See Also
java.lang.String#compareTo(java.lang.String), java.lang.String#equalsIgnoreCase(java.lang.String)
equalsback to summary
public boolean equals(String anotherString)

Compares this string to the specified 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
anotherString:String

the object to compare this String against.

Returns:boolean

true if the Strings are equal; false otherwise.

See Also
java.lang.String#compareTo(java.lang.String), java.lang.String#equalsIgnoreCase(java.lang.String)
equalsback to summary
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:Object

the object to compare this String against.

Returns:boolean

true if the String are equal; false otherwise.

See Also
java.lang.String#compareTo(java.lang.String), java.lang.String#equalsIgnoreCase(java.lang.String)
equalsIgnoreCaseback to summary
public boolean equalsIgnoreCase(String anotherString)

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:String

the String to compare this String against.

Returns:boolean

true if the argument is not null and the Strings are equal, ignoring case; false otherwise.

See Also
equals(Object), java.lang.Character#toLowerCase(char), java.lang.Character#toUpperCase(char)
fixWhiteSpaceback to summary
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.

Parameters
trimHead:boolean

Trim leading whitespace?

trimTail:boolean

Trim trailing whitespace?

doublePunctuationSpaces:boolean

Use double spaces for punctuation?

Returns:XMLString

The trimmed string.

getCharsback to summary
public void getChars(int srcBegin, int srcEnd, char[] dst, int dstBegin)

Copies characters from this string into the destination character array.

Parameters
srcBegin:int

index of the first character in the string to copy.

srcEnd:int

index after the last character in the string to copy.

dst:char[]

the destination array.

dstBegin:int

the start offset in the destination array.

Exceptions
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
NullPointerException:
if dst is null
hashCodeback to summary
public int hashCode()

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.)
Returns:int

a hash code value for this object.

hasStringback to summary
public boolean hasString()

Tell if this object contains a java String object.

Returns:boolean

true if this XMLString can return a string without creating one.

indexOfback to summary
public int indexOf(int ch)

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:int

a character.

Returns:int

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.

indexOfback to summary
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. 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:int

a character.

fromIndex:int

the index to start the search from.

Returns:int

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.

indexOfback to summary
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:

this.startsWith(str, k)
is true.
Parameters
str:String

any string.

Returns:int

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.

Exceptions
NullPointerException:
if str is null.
indexOfback to summary
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:

this.startsWith(str, k)
is true.
Parameters
str:XMLString

any string.

Returns:int

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.

Exceptions
NullPointerException:
if str is null.
indexOfback to summary
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:

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:String

the substring to search for.

fromIndex:int

the index to start the search from.

Returns:int

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.

Exceptions
NullPointerException:
if str is null
lastIndexOfback to summary
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:

this.charAt(k) == ch
is true. The String is searched backwards starting at the last character.
Parameters
ch:int

a character.

Returns:int

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.

lastIndexOfback to summary
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:

this.charAt(k) == ch) && (k <= fromIndex)
is true.
Parameters
ch:int

a character.

fromIndex:int

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:int

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.

lastIndexOfback to summary
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 value this.length(). The returned index is the largest value k such that

this.startsWith(str, k)
is true.
Parameters
str:String

the substring to search for.

Returns:int

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.

Exceptions
NullPointerException:
if str is null.
lastIndexOfback to summary
public int lastIndexOf(String str, int fromIndex)

Returns the index within this string of the last occurrence of the specified substring.

Parameters
str:String

the substring to search for.

fromIndex: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.

Returns:int

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.

Exceptions
NullPointerException:
if str is null.
lengthback to summary
public int length()

Returns the length of this string.

Returns:int

the length of the sequence of characters represented by this object.

startsWithback to summary
public boolean startsWith(String prefix, int toffset)

Tests if this string starts with the specified prefix beginning a specified index.

Parameters
prefix:String

the prefix.

toffset:int

where to begin looking in the string.

Returns:boolean

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)
         
Exceptions
NullPointerException:
if prefix is null.
startsWithback to summary
public boolean startsWith(XMLString prefix, int toffset)

Tests if this string starts with the specified prefix beginning a specified index.

Parameters
prefix:XMLString

the prefix.

toffset:int

where to begin looking in the string.

Returns:boolean

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)
         
Exceptions
NullPointerException:
if prefix is null.
startsWithback to summary
public boolean startsWith(String prefix)

Tests if this string starts with the specified prefix.

Parameters
prefix:String

the prefix.

Returns:boolean

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.

Exceptions
NullPointerException:
if prefix is null.
Since
JDK1. 0
startsWithback to summary
public boolean startsWith(XMLString prefix)

Tests if this string starts with the specified prefix.

Parameters
prefix:XMLString

the prefix.

Returns:boolean

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.

Exceptions
NullPointerException:
if prefix is null.
Since
JDK1. 0
substringback to summary
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:int

the beginning index, inclusive.

Returns:XMLString

the specified substring.

Exceptions
IndexOutOfBoundsException:
if beginIndex is negative or larger than the length of this String object.
substringback to summary
public XMLString substring(int beginIndex, int endIndex)

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:int

the beginning index, inclusive.

endIndex:int

the ending index, exclusive.

Returns:XMLString

the specified substring.

Exceptions
IndexOutOfBoundsException:
if the beginIndex is negative, or endIndex is larger than the length of this String object, or beginIndex is larger than endIndex.
toDoubleback to summary
public double toDouble()

Convert a string to a double -- Allowed input is in fixed notation ddd.fff.

Returns:double

A double value representation of the string, or return Double.NaN if the string can not be converted.

toLowerCaseback to summary
public XMLString toLowerCase(Locale locale)

Converts all of the characters in this String to lower case using the rules of the given Locale.

Parameters
locale:Locale

use the case transformation rules for this locale

Returns:XMLString

the String, converted to lowercase.

See Also
java.lang.Character#toLowerCase(char), java.lang.String#toUpperCase(Locale)
toLowerCaseback to summary
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.

Returns:XMLString

the string, converted to lowercase.

See Also
java.lang.Character#toLowerCase(char), java.lang.String#toLowerCase(Locale)
toStringback to summary
public String toString()

This object (which is already a string!) is itself returned.

Returns:String

the string itself.

toUpperCaseback to summary
public XMLString toUpperCase(Locale locale)

Converts all of the characters in this String to upper case using the rules of the given locale.

Parameters
locale:Locale

use the case transformation rules for this locale

Returns:XMLString

the String, converted to uppercase.

See Also
java.lang.Character#toUpperCase(char), java.lang.String#toLowerCase(Locale)
toUpperCaseback to summary
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.

Examples:

"Fahrvergnügen".toUpperCase() returns "FAHRVERGNÜGEN"
"Visit Ljubinje!".toUpperCase() returns "VISIT LJUBINJE!"
Returns:XMLString

the string, converted to uppercase.

See Also
java.lang.Character#toUpperCase(char), java.lang.String#toUpperCase(Locale)
trimback to summary
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'. 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(km+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.

Returns:XMLString

this string, with white space removed from the front and end.