| java.lang.Object java.lang.String
String | final public class String implements java.io.Serializable,Comparable<String>,CharSequence(Code) | | The String class represents character strings. All
string literals in Java programs, such as "abc" , are
implemented as instances of this class.
Strings are constant; their values cannot be changed after they
are created. String buffers support mutable strings.
Because String objects are immutable they can be shared. For example:
String str = "abc";
is equivalent to:
char data[] = {'a', 'b', 'c'};
String str = new String(data);
Here are some more examples of how strings can be used:
System.out.println("abc");
String cde = "cde";
System.out.println("abc" + cde);
String c = "abc".substring(2,3);
String d = cde.substring(1, 2);
The class String includes methods for examining
individual characters of the sequence, for comparing strings, for
searching strings, for extracting substrings, and for creating a
copy of a string with all characters translated to uppercase or to
lowercase. Case mapping is based on the Unicode Standard version
specified by the
java.lang.Character Character class.
The Java language provides special support for the string
concatenation operator ( + ), and for conversion of
other objects to strings. String concatenation is implemented
through the StringBuilder (or StringBuffer )
class and its append method.
String conversions are implemented through the method
toString , defined by Object and
inherited by all classes in Java. For additional information on
string concatenation and conversion, see Gosling, Joy, and Steele,
The Java Language Specification.
Unless otherwise noted, passing a null argument to a constructor
or method in this class will cause a
NullPointerException to be
thrown.
A String represents a string in the UTF-16 format
in which supplementary characters are represented by surrogate
pairs (see the section Unicode
Character Representations in the Character class for
more information).
Index values refer to char code units, so a supplementary
character uses two positions in a String .
The String class provides methods for dealing with
Unicode code points (i.e., characters), in addition to those for
dealing with Unicode code units (i.e., char values).
author: Lee Boynton author: Arthur van Hoff version: 1.212, 05/05/07 See Also: java.lang.Object.toString See Also: java.lang.StringBuffer See Also: java.lang.StringBuilder See Also: java.nio.charset.Charset since: JDK1.0 |
Constructor Summary | |
public | String() Initializes a newly created
String object so that it represents
an empty character sequence. | public | String(String original) Initializes a newly created
String object so that it represents
the same sequence of characters as the argument; in other words, the
newly created string is a copy of the argument string. | public | String(char value) Allocates a new
String so that it represents the sequence of
characters currently contained in the character array argument. | public | String(char value, int offset, int count) Allocates a new
String that contains characters from a subarray
of the character array argument. | public | String(int[] codePoints, int offset, int count) Allocates a new
String that contains characters from a subarray
of the Unicode code point array argument. | public | String(byte ascii, int hibyte, int offset, int count) Allocates a new
String constructed from a subarray of an array
of 8-bit integer values. | public | String(byte ascii, int hibyte) Allocates a new
String containing characters constructed from
an array of 8-bit integer values. | public | String(byte bytes, int offset, int length, String charsetName) Constructs a new
String by decoding the specified subarray of
bytes using the specified charset. | public | String(byte bytes, int offset, int length, Charset charset) Constructs a new
String by decoding the specified subarray of
bytes using the specified
.
The length of the new
String is a function of the charset, and
hence may not be equal to the length of the subarray.
This method always replaces malformed-input and unmappable-character
sequences with this charset's default replacement string. | public | String(byte bytes, String charsetName) Constructs a new
String by decoding the specified array of bytes
using the specified
. | public | String(byte bytes, Charset charset) Constructs a new
String by decoding the specified array of
bytes using the specified
.
The length of the new
String is a function of the charset, and
hence may not be equal to the length of the byte array.
This method always replaces malformed-input and unmappable-character
sequences with this charset's default replacement string. | public | String(byte bytes, int offset, int length) Constructs a new
String by decoding the specified subarray of
bytes using the platform's default charset. | public | String(byte bytes) Constructs a new
String by decoding the specified array of bytes
using the platform's default charset. | public | String(StringBuffer buffer) Allocates a new string that contains the sequence of characters
currently contained in the string buffer argument. | public | String(StringBuilder builder) Allocates a new string that contains the sequence of characters
currently contained in the string builder argument. | | String(int offset, int count, char value) |
Method Summary | |
public char | charAt(int index) Returns the char value at the
specified index. | public int | codePointAt(int index) Returns the character (Unicode code point) at the specified
index. | public int | codePointBefore(int index) Returns the character (Unicode code point) before the specified
index. | public int | codePointCount(int beginIndex, int endIndex) Returns the number of Unicode code points in the specified text
range of this String . | public int | compareTo(String anotherString) Compares two strings lexicographically.
The comparison is based on the Unicode value of each character in
the strings. | public int | compareToIgnoreCase(String str) Compares two strings lexicographically, ignoring case
differences. | public String | concat(String str) Concatenates the specified string to the end of this string.
If the length of the argument string is 0 , then this
String object is returned. | public boolean | contains(CharSequence s) Returns true if and only if this string contains the specified
sequence of char values. | public boolean | contentEquals(StringBuffer sb) Compares this string to the specified
StringBuffer . | public boolean | contentEquals(CharSequence cs) Compares this string to the specified
CharSequence . | public static String | copyValueOf(char data, int offset, int count) Returns a String that represents the character sequence in the
array specified.
Parameters: data - the character array. Parameters: offset - initial offset of the subarray. Parameters: count - length of the subarray. | public static String | copyValueOf(char data) Returns a String that represents the character sequence in the
array specified.
Parameters: data - the character array. | public boolean | endsWith(String suffix) Tests if this string ends with the specified suffix.
Parameters: suffix - the suffix. | public boolean | equals(Object anObject) Compares this string to the specified object. | public boolean | equalsIgnoreCase(String anotherString) Compares this
String to another
String , ignoring case
considerations. | public static String | format(String format, Object... args) Returns a formatted string using the specified format string and
arguments.
The locale always used is the one returned by
java.util.Locale.getDefault Locale.getDefault() .
Parameters: format - A format string Parameters: args - Arguments referenced by the format specifiers in the formatstring. | public static String | format(Locale l, String format, Object... args) Returns a formatted string using the specified locale, format string,
and arguments.
Parameters: l - The to apply duringformatting. | public void | getBytes(int srcBegin, int srcEnd, byte dst, int dstBegin) Copies characters from this string into the destination byte array. | public byte[] | getBytes(String charsetName) Encodes this
String into a sequence of bytes using the named
charset, storing the result into a new byte array.
The behavior of this method when this string cannot be encoded in
the given charset is unspecified. | public byte[] | getBytes(Charset charset) Encodes this
String into a sequence of bytes using the given
, storing the result into a
new byte array.
This method always replaces malformed-input and unmappable-character
sequences with this charset's default replacement byte array. | public byte[] | getBytes() Encodes this
String into a sequence of bytes using the
platform's default charset, storing the result into a new byte array.
The behavior of this method when this string cannot be encoded in
the default charset is unspecified. | void | getChars(char dst, int dstBegin) Copy characters from this string into dst starting at dstBegin. | public void | getChars(int srcBegin, int srcEnd, char dst, int dstBegin) Copies characters from this string into the destination character
array.
The first character to be copied is at index srcBegin ;
the last character to be copied is at index srcEnd-1
(thus the total number of characters to be copied is
srcEnd-srcBegin ). | public int | hashCode() Returns a hash code for this string. | public int | indexOf(int ch) Returns the index within this string of the first occurrence of
the specified character. | 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. | public int | indexOf(String str) Returns the index within this string of the first occurrence of the
specified substring. | 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. | static int | indexOf(char[] source, int sourceOffset, int sourceCount, char[] target, int targetOffset, int targetCount, int fromIndex) Code shared by String and StringBuffer to do searches. | native public String | intern() Returns a canonical representation for the string object.
A pool of strings, initially empty, is maintained privately by the
class String .
When the intern method is invoked, if the pool already contains a
string equal to this String object as determined by
the
String.equals(Object) method, then the string from the pool is
returned. | public boolean | isEmpty() Returns true if, and only if,
String.length() is 0. | public int | lastIndexOf(int ch) Returns the index within this string of the last occurrence of
the specified character. | 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. | public int | lastIndexOf(String str) Returns the index within this string of the rightmost occurrence
of the specified substring. | public int | lastIndexOf(String str, int fromIndex) Returns the index within this string of the last occurrence of the
specified substring, searching backward starting at the specified index.
The integer returned is the largest value k such that:
k <= Math.min(fromIndex, this.length()) && this.startsWith(str, k)
If no such value of k exists, then -1 is returned.
Parameters: str - the substring to search for. Parameters: fromIndex - the index to start the search from. | static int | lastIndexOf(char[] source, int sourceOffset, int sourceCount, char[] target, int targetOffset, int targetCount, int fromIndex) Code shared by String and StringBuffer to do searches. | public int | length() Returns the length of this string. | public boolean | matches(String regex) Tells whether or not this string matches the given regular expression. | public int | offsetByCodePoints(int index, int codePointOffset) Returns the index within this String that is
offset from the given index by
codePointOffset code points. | public boolean | regionMatches(int toffset, String other, int ooffset, int len) Tests if two string regions are equal.
A substring of this String object is compared to a substring
of the argument other. | public boolean | regionMatches(boolean ignoreCase, int toffset, String other, int ooffset, int len) Tests if two string regions are equal.
A substring of this String object is compared to a substring
of the argument other. | public String | replace(char oldChar, char newChar) Returns a new string resulting from replacing all occurrences of
oldChar in this string with newChar .
If the character oldChar does not occur in the
character sequence represented by this String object,
then a reference to this String object is returned.
Otherwise, a new String object is created that
represents a character sequence identical to the character sequence
represented by this String object, except that every
occurrence of oldChar is replaced by an occurrence
of newChar .
Examples:
"mesquite in your cellar".replace('e', 'o')
returns "mosquito in your collar"
"the war of baronets".replace('r', 'y')
returns "the way of bayonets"
"sparring with a purple porpoise".replace('p', 't')
returns "starring with a turtle tortoise"
"JonL".replace('q', 'x') returns "JonL" (no change)
Parameters: oldChar - the old character. Parameters: newChar - the new character. | public String | replace(CharSequence target, CharSequence replacement) Replaces each substring of this string that matches the literal target
sequence with the specified literal replacement sequence. | public String | replaceAll(String regex, String replacement) Replaces each substring of this string that matches the given regular expression with the
given replacement. | public String | replaceFirst(String regex, String replacement) Replaces the first substring of this string that matches the given regular expression with the
given replacement. | public String[] | split(String regex, int limit) Splits this string around matches of the given
regular expression.
The array returned by this method contains each substring of this
string that is terminated by another substring that matches the given
expression or is terminated by the end of the string. | public String[] | split(String regex) Splits this string around matches of the given regular expression.
This method works as if by invoking the two-argument
String.split(String,int) split method with the given expression and a limit
argument of zero. | public boolean | startsWith(String prefix, int toffset) Tests if the substring of this string beginning at the
specified index starts with the specified prefix.
Parameters: prefix - the prefix. Parameters: toffset - where to begin looking in this string. | public boolean | startsWith(String prefix) Tests if this string starts with the specified prefix.
Parameters: prefix - the prefix. | public CharSequence | subSequence(int beginIndex, int endIndex) Returns a new character sequence that is a subsequence of this sequence.
An invocation of this method of the form
str.subSequence(begin, end)
behaves in exactly the same way as the invocation
str.substring(begin, end)
This method is defined so that the String class can implement
the
CharSequence interface. | public String | substring(int beginIndex) Returns a new string that is a substring of this string. | public String | substring(int beginIndex, int endIndex) Returns a new string that is a substring of this string. | public char[] | toCharArray() Converts this string to a new character array. | public String | toLowerCase(Locale locale) Converts all of the characters in this String to lower
case using the rules of the given Locale . | public String | toLowerCase() Converts all of the characters in this String to lower
case using the rules of the default locale. | public String | toString() This object (which is already a string!) is itself returned. | public String | toUpperCase(Locale locale) Converts all of the characters in this String to upper
case using the rules of the given Locale . | public String | toUpperCase() Converts all of the characters in this String to upper
case using the rules of the default locale. | public String | trim() Returns a copy of the string, with leading and trailing whitespace
omitted.
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' . | public static String | valueOf(Object obj) Returns the string representation of the Object argument.
Parameters: obj - an Object . | public static String | valueOf(char data) Returns the string representation of the char array
argument. | public static String | valueOf(char data, int offset, int count) Returns the string representation of a specific subarray of the
char array argument.
The offset argument is the index of the first
character of the subarray. | public static String | valueOf(boolean b) Returns the string representation of the boolean argument.
Parameters: b - a boolean . | public static String | valueOf(char c) Returns the string representation of the char
argument.
Parameters: c - a char . | public static String | valueOf(int i) Returns the string representation of the int argument.
The representation is exactly the one returned by the
Integer.toString method of one argument.
Parameters: i - an int . | public static String | valueOf(long l) Returns the string representation of the long argument.
The representation is exactly the one returned by the
Long.toString method of one argument.
Parameters: l - a long . | public static String | valueOf(float f) Returns the string representation of the float argument.
The representation is exactly the one returned by the
Float.toString method of one argument.
Parameters: f - a float . | public static String | valueOf(double d) Returns the string representation of the double argument.
The representation is exactly the one returned by the
Double.toString method of one argument.
Parameters: d - a double . |
CASE_INSENSITIVE_ORDER | final public static Comparator<String> CASE_INSENSITIVE_ORDER(Code) | | A Comparator that orders String objects as by
compareToIgnoreCase . This comparator is serializable.
Note that this Comparator 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.
See Also: java.text.Collator.compare(StringString) since: 1.2 |
String | public String()(Code) | | Initializes a newly created
String object so that it represents
an empty character sequence. Note that use of this constructor is
unnecessary since Strings are immutable.
|
String | public String(String original)(Code) | | Initializes a newly created
String object so that it represents
the same sequence of characters as the argument; in other words, the
newly created string is a copy of the argument string. Unless an
explicit copy of
original is needed, use of this constructor is
unnecessary since Strings are immutable.
Parameters: original - A String |
String | public String(char value)(Code) | | Allocates a new
String so that it represents the sequence of
characters currently contained in the character array argument. The
contents of the character array are copied; subsequent modification of
the character array does not affect the newly created string.
Parameters: value - The initial value of the string |
String | public String(char value, int offset, int count)(Code) | | Allocates a new
String that contains characters from a subarray
of the character array argument. The
offset argument is the
index of the first character of the subarray and the
count argument specifies the length of the subarray. The contents of the
subarray are copied; subsequent modification of the character array does
not affect the newly created string.
Parameters: value - Array that is the source of characters Parameters: offset - The initial offset Parameters: count - The length throws: IndexOutOfBoundsException - If the offset and count arguments indexcharacters outside the bounds of the value array |
String | public String(int[] codePoints, int offset, int count)(Code) | | Allocates a new
String that contains characters from a subarray
of the Unicode code point array argument. The
offset argument
is the index of the first code point of the subarray and the
count argument specifies the length of the subarray. The
contents of the subarray are converted to
char s; subsequent
modification of the
int array does not affect the newly created
string.
Parameters: codePoints - Array that is the source of Unicode code points Parameters: offset - The initial offset Parameters: count - The length throws: IllegalArgumentException - If any invalid Unicode code point is found in codePoints throws: IndexOutOfBoundsException - If the offset and count arguments indexcharacters outside the bounds of the codePoints array since: 1.5 |
String | public String(byte ascii, int hibyte, int offset, int count)(Code) | | Allocates a new
String constructed from a subarray of an array
of 8-bit integer values.
The
offset argument is the index of the first byte of the
subarray, and the
count argument specifies the length of the
subarray.
Each
byte in the subarray is converted to a
char as
specified in the method above.
String java.nio.charset.Charset Parameters: ascii - The bytes to be converted to characters Parameters: hibyte - The top 8 bits of each 16-bit Unicode code unit Parameters: offset - The initial offset Parameters: count - The length throws: IndexOutOfBoundsException - If the offset or count argument is invalid See Also: String.String(byte[],int) See Also: String.String(byte[],int,int,java.lang.String) See Also: String.String(byte[],int,int,java.nio.charset.Charset) See Also: String.String(byte[],int,int) See Also: String.String(byte[],java.lang.String) See Also: String.String(byte[],java.nio.charset.Charset) See Also: String.String(byte[]) |
String | public String(byte ascii, int hibyte)(Code) | | Allocates a new
String containing characters constructed from
an array of 8-bit integer values. Each character cin the
resulting string is constructed from the corresponding component
b in the byte array such that:
c == (char)(((hibyte & 0xff) << 8)
| (b & 0xff))
String java.nio.charset.Charset Parameters: ascii - The bytes to be converted to characters Parameters: hibyte - The top 8 bits of each 16-bit Unicode code unit See Also: String.String(byte[],int,int,java.lang.String) See Also: String.String(byte[],int,int,java.nio.charset.Charset) See Also: String.String(byte[],int,int) See Also: String.String(byte[],java.lang.String) See Also: String.String(byte[],java.nio.charset.Charset) See Also: String.String(byte[]) |
String | public String(byte bytes, int offset, int length, String charsetName) throws UnsupportedEncodingException(Code) | | Constructs a new
String by decoding the specified subarray of
bytes using the specified charset. The length of the new
String is a function of the charset, and hence may not be equal to the length
of the subarray.
The behavior of this constructor when the given bytes are not valid
in the given charset is unspecified. The
java.nio.charset.CharsetDecoder class should be used when more control
over the decoding process is required.
Parameters: bytes - The bytes to be decoded into characters Parameters: offset - The index of the first byte to decode Parameters: length - The number of bytes to decode Parameters: charsetName - The name of a supported throws: UnsupportedEncodingException - If the named charset is not supported throws: IndexOutOfBoundsException - If the offset and length arguments indexcharacters outside the bounds of the bytes array since: JDK1.1 |
String | public String(byte bytes, int offset, int length, Charset charset)(Code) | | Constructs a new
String by decoding the specified subarray of
bytes using the specified
.
The length of the new
String is a function of the charset, and
hence may not be equal to the length of the subarray.
This method always replaces malformed-input and unmappable-character
sequences with this charset's default replacement string. The
java.nio.charset.CharsetDecoder class should be used when more control
over the decoding process is required.
Parameters: bytes - The bytes to be decoded into characters Parameters: offset - The index of the first byte to decode Parameters: length - The number of bytes to decode Parameters: charset - The to be used todecode the bytes throws: IndexOutOfBoundsException - If the offset and length arguments indexcharacters outside the bounds of the bytes array since: 1.6 |
String | public String(byte bytes, String charsetName) throws UnsupportedEncodingException(Code) | | Constructs a new
String by decoding the specified array of bytes
using the specified
. The
length of the new
String is a function of the charset, and hence
may not be equal to the length of the byte array.
The behavior of this constructor when the given bytes are not valid
in the given charset is unspecified. The
java.nio.charset.CharsetDecoder class should be used when more control
over the decoding process is required.
Parameters: bytes - The bytes to be decoded into characters Parameters: charsetName - The name of a supported throws: UnsupportedEncodingException - If the named charset is not supported since: JDK1.1 |
String | public String(byte bytes, Charset charset)(Code) | | Constructs a new
String by decoding the specified array of
bytes using the specified
.
The length of the new
String is a function of the charset, and
hence may not be equal to the length of the byte array.
This method always replaces malformed-input and unmappable-character
sequences with this charset's default replacement string. The
java.nio.charset.CharsetDecoder class should be used when more control
over the decoding process is required.
Parameters: bytes - The bytes to be decoded into characters Parameters: charset - The to be used todecode the bytes since: 1.6 |
String | public String(byte bytes, int offset, int length)(Code) | | Constructs a new
String by decoding the specified subarray of
bytes using the platform's default charset. The length of the new
String is a function of the charset, and hence may not be equal
to the length of the subarray.
The behavior of this constructor when the given bytes are not valid
in the default charset is unspecified. The
java.nio.charset.CharsetDecoder class should be used when more control
over the decoding process is required.
Parameters: bytes - The bytes to be decoded into characters Parameters: offset - The index of the first byte to decode Parameters: length - The number of bytes to decode throws: IndexOutOfBoundsException - If the offset and the length arguments indexcharacters outside the bounds of the bytes array since: JDK1.1 |
String | public String(byte bytes)(Code) | | Constructs a new
String by decoding the specified array of bytes
using the platform's default charset. The length of the new
String is a function of the charset, and hence may not be equal to the
length of the byte array.
The behavior of this constructor when the given bytes are not valid
in the default charset is unspecified. The
java.nio.charset.CharsetDecoder class should be used when more control
over the decoding process is required.
Parameters: bytes - The bytes to be decoded into characters since: JDK1.1 |
String | public String(StringBuffer buffer)(Code) | | Allocates a new string that contains the sequence of characters
currently contained in the string buffer argument. The contents of the
string buffer are copied; subsequent modification of the string buffer
does not affect the newly created string.
Parameters: buffer - A StringBuffer |
String | public String(StringBuilder builder)(Code) | | Allocates a new string that contains the sequence of characters
currently contained in the string builder argument. The contents of the
string builder are copied; subsequent modification of the string builder
does not affect the newly created string.
This constructor is provided to ease migration to
StringBuilder . Obtaining a string from a string builder via the
toString method is likely to run faster and is generally preferred.
Parameters: builder - A StringBuilder since: 1.5 |
String | String(int offset, int count, char value)(Code) | | |
charAt | public char charAt(int index)(Code) | | Returns the char value at the
specified index. An index ranges from 0 to
length() - 1 . The first char value of the sequence
is at index 0 , the next at index 1 ,
and so on, as for array indexing.
If the char value specified by the index is a
surrogate, the surrogate
value is returned.
Parameters: index - the index of the char value. the char value at the specified index of this string.The first char value is at index 0 . exception: IndexOutOfBoundsException - if the index argument is negative or not less than the length of thisstring. |
codePointAt | public int codePointAt(int index)(Code) | | Returns the character (Unicode code point) at the specified
index. The index refers to char values
(Unicode code units) and ranges from 0 to
String.length() - 1 .
If the char value specified at the given index
is in the high-surrogate range, the following index is less
than the length of this String , and the
char value at the following index is in the
low-surrogate range, then the supplementary code point
corresponding to this surrogate pair is returned. Otherwise,
the char value at the given index is returned.
Parameters: index - the index to the char values the code point value of the character at theindex exception: IndexOutOfBoundsException - if the index argument is negative or not less than the length of thisstring. since: 1.5 |
codePointBefore | public int codePointBefore(int index)(Code) | | Returns the character (Unicode code point) before the specified
index. The index refers to char values
(Unicode code units) and ranges from 1 to
CharSequence.length length .
If the char value at (index - 1)
is in the low-surrogate range, (index - 2) is not
negative, and the char value at (index -
2) is in the high-surrogate range, then the
supplementary code point value of the surrogate pair is
returned. If the char value at index -
1 is an unpaired low-surrogate or a high-surrogate, the
surrogate value is returned.
Parameters: index - the index following the code point that should be returned the Unicode code point value before the given index. exception: IndexOutOfBoundsException - if the index argument is less than 1 or greater than the lengthof this string. since: 1.5 |
codePointCount | public int codePointCount(int beginIndex, int endIndex)(Code) | | Returns the number of Unicode code points in the specified text
range of this String . The text range begins at the
specified beginIndex and extends to the
char at index endIndex - 1 . Thus the
length (in char s) of the text range is
endIndex-beginIndex . Unpaired surrogates within
the text range count as one code point each.
Parameters: beginIndex - the index to the first char ofthe text range. Parameters: endIndex - the index after the last char ofthe text range. the number of Unicode code points in the specified textrange exception: IndexOutOfBoundsException - if thebeginIndex is negative, or endIndex is larger than the length of this String , orbeginIndex is larger than endIndex . since: 1.5 |
compareTo | public int compareTo(String anotherString)(Code) | | Compares two strings lexicographically.
The comparison is based on the Unicode value of each character in
the strings. The character sequence represented by this
String object is compared lexicographically to the
character sequence represented by the argument string. The result is
a negative integer if this String object
lexicographically precedes the argument string. The result is a
positive integer if this String object lexicographically
follows the argument string. The result is zero if the strings
are equal; compareTo returns 0 exactly when
the
String.equals(Object) method would return true .
This is the definition of lexicographic ordering. If two strings are
different, then either they have different characters at some index
that is a valid index for both strings, or their lengths are different,
or both. If they have different characters at one or more index
positions, let k be the smallest such index; then the string
whose character at position k has the smaller value, as
determined by using the < operator, lexicographically precedes the
other string. In this case, compareTo returns the
difference of the two character values at position k in
the two string -- that is, the value:
this.charAt(k)-anotherString.charAt(k)
If there is no index position at which they differ, then the shorter
string lexicographically precedes the longer string. In this case,
compareTo returns the difference of the lengths of the
strings -- that is, the value:
this.length()-anotherString.length()
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. |
compareToIgnoreCase | public int compareToIgnoreCase(String str)(Code) | | Compares two strings lexicographically, ignoring case
differences. This method returns an integer whose sign is that of
calling compareTo with normalized versions of the strings
where case differences have been eliminated by calling
Character.toLowerCase(Character.toUpperCase(character)) on
each character.
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 thespecified String is greater than, equal to, or lessthan this String, ignoring case considerations. See Also: java.text.Collator.compare(StringString) since: 1.2 |
concat | public String concat(String str)(Code) | | Concatenates the specified string to the end of this string.
If the length of the argument string is 0 , then this
String object is returned. Otherwise, a new
String object is created, representing a character
sequence that is the concatenation of the character sequence
represented by this String object and the character
sequence represented by the argument string.
Examples:
"cares".concat("s") returns "caress"
"to".concat("get").concat("her") returns "together"
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. |
contains | public boolean contains(CharSequence s)(Code) | | Returns true if and only if this string contains the specified
sequence of char values.
Parameters: s - the sequence to search for true if this string contains s , false otherwise throws: NullPointerException - if s is null since: 1.5 |
contentEquals | public boolean contentEquals(StringBuffer sb)(Code) | | Compares this string to the specified
StringBuffer . The result
is
true if and only if this
String represents the same
sequence of characters as the specified
StringBuffer .
Parameters: sb - The StringBuffer to compare this String against true if this String represents the samesequence of characters as the specified StringBuffer , false otherwise since: 1.4 |
contentEquals | public boolean contentEquals(CharSequence cs)(Code) | | Compares this string to the specified
CharSequence . The result
is
true if and only if this
String represents the same
sequence of char values as the specified sequence.
Parameters: cs - The sequence to compare this String against true if this String represents the samesequence of char values as the specified sequence, false otherwise since: 1.5 |
copyValueOf | public static String copyValueOf(char data, int offset, int count)(Code) | | Returns a String that represents the character sequence in the
array specified.
Parameters: data - the character array. Parameters: offset - initial offset of the subarray. Parameters: count - length of the subarray. a String that contains the characters of thespecified subarray of the character array. |
copyValueOf | public static String copyValueOf(char data)(Code) | | Returns a String that represents the character sequence in the
array specified.
Parameters: data - the character array. a String that contains the characters of thecharacter array. |
endsWith | 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 String.equals(Object) method. |
equals | public boolean equals(Object anObject)(Code) | | 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 String against true if the given object represents a String equivalent to this string, false otherwise See Also: String.compareTo(String) See Also: String.equalsIgnoreCase(String) |
equalsIgnoreCase | 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.
Two characters
c1 and
c2 are considered the same
ignoring case if at least one of the following is true:
Parameters: anotherString - The String to compare this String against true if the argument is not null and itrepresents an equivalent String ignoring case; false otherwise See Also: String.equals(Object) |
format | public static String format(String format, Object... args)(Code) | | Returns a formatted string using the specified format string and
arguments.
The locale always used is the one returned by
java.util.Locale.getDefault Locale.getDefault() .
Parameters: format - A format string Parameters: args - Arguments referenced by the format specifiers in the formatstring. If there are more arguments than format specifiers, theextra arguments are ignored. The number of arguments isvariable and may be zero. The maximum number of arguments islimited by the maximum dimension of a Java array as defined bythe JavaVirtual Machine Specification. The behaviour on anull argument depends on the conversion. throws: IllegalFormatException - If a format string contains an illegal syntax, a formatspecifier that is incompatible with the given arguments,insufficient arguments given the format string, or otherillegal conditions. For specification of all possibleformatting errors, see the Details section of theformatter class specification. throws: NullPointerException - If the format is null A formatted string See Also: java.util.Formatter since: 1.5 |
format | public static String format(Locale l, String format, Object... args)(Code) | | Returns a formatted string using the specified locale, format string,
and arguments.
Parameters: l - The to apply duringformatting. If l is null then no localizationis applied. Parameters: format - A format string Parameters: args - Arguments referenced by the format specifiers in the formatstring. If there are more arguments than format specifiers, theextra arguments are ignored. The number of arguments isvariable and may be zero. The maximum number of arguments islimited by the maximum dimension of a Java array as defined bythe JavaVirtual Machine Specification. The behaviour on anull argument depends on the conversion. throws: IllegalFormatException - If a format string contains an illegal syntax, a formatspecifier that is incompatible with the given arguments,insufficient arguments given the format string, or otherillegal conditions. For specification of all possibleformatting errors, see the Details section of theformatter class specification throws: NullPointerException - If the format is null A formatted string See Also: java.util.Formatter since: 1.5 |
getBytes | public void getBytes(int srcBegin, int srcEnd, byte dst, int dstBegin)(Code) | | Copies characters from this string into the destination byte array. Each
byte receives the 8 low-order bits of the corresponding character. The
eight high-order bits of each character are not copied and do not
participate in the transfer in any way.
The first character to be copied is at index
srcBegin ; the
last character to be copied is at index
srcEnd-1 . The total
number of characters to be copied is
srcEnd-srcBegin . The
characters, converted to bytes, are copied into the subarray of
dst starting at index
dstBegin and ending at index:
dstbegin + (srcEnd-srcBegin) - 1
String.getBytes() Parameters: srcBegin - Index of the first character in the string to copy Parameters: srcEnd - Index after the last character in the string to copy Parameters: dst - The destination array Parameters: dstBegin - The start offset in the destination array throws: 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
|
getBytes | public byte[] getBytes(String charsetName) throws UnsupportedEncodingException(Code) | | Encodes this
String into a sequence of bytes using the named
charset, storing the result into a new byte array.
The behavior of this method when this string cannot be encoded in
the given charset is unspecified. The
java.nio.charset.CharsetEncoder class should be used when more control
over the encoding process is required.
Parameters: charsetName - The name of a supported The resultant byte array throws: UnsupportedEncodingException - If the named charset is not supported since: JDK1.1 |
getBytes | public byte[] getBytes(Charset charset)(Code) | | Encodes this
String into a sequence of bytes using the given
, storing the result into a
new byte array.
This method always replaces malformed-input and unmappable-character
sequences with this charset's default replacement byte array. The
java.nio.charset.CharsetEncoder class should be used when more
control over the encoding process is required.
Parameters: charset - The to be used to encodethe String The resultant byte array since: 1.6 |
getBytes | public byte[] getBytes()(Code) | | Encodes this
String into a sequence of bytes using the
platform's default charset, storing the result into a new byte array.
The behavior of this method when this string cannot be encoded in
the default charset is unspecified. The
java.nio.charset.CharsetEncoder class should be used when more control
over the encoding process is required.
The resultant byte array since: JDK1.1 |
getChars | void getChars(char dst, int dstBegin)(Code) | | Copy characters from this string into dst starting at dstBegin.
This method doesn't perform any range checking.
|
getChars | public void getChars(int srcBegin, int srcEnd, char dst, int dstBegin)(Code) | | Copies characters from this string into the destination character
array.
The first character to be copied is at index srcBegin ;
the last character to be copied is at index srcEnd-1
(thus the total number of characters to be copied is
srcEnd-srcBegin ). The characters are copied into the
subarray of dst starting at index dstBegin
and ending at index:
dstbegin + (srcEnd-srcBegin) - 1
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 srcEnd srcEnd is greater than the length of thisstringdstBegin is negativedstBegin+(srcEnd-srcBegin) is larger thandst.length
|
hashCode | public int hashCode()(Code) | | Returns a hash code for this string. The hash code 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 | 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 (in Unicode
code units) of the first such occurrence is returned. For
values of ch in the range from 0 to 0xFFFF
(inclusive), this is the smallest value k such that:
this.charAt(k) == ch
is true. For other values of ch , it is the
smallest value k such that:
this.codePointAt(k) == ch
is true. In either case, if no such character occurs in this
string, then -1 is returned.
Parameters: ch - a character (Unicode code point). 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 | 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. For values
of ch in the range from 0 to 0xFFFF (inclusive),
this is the smallest value k such that:
(this.charAt(k) == ch) && (k >= fromIndex)
is true. For other values of ch , it is the
smallest value k such that:
(this.codePointAt(k) == ch) && (k >= fromIndex)
is true. In either case, 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.
All indices are specified in char values
(Unicode code units).
Parameters: ch - a character (Unicode code point). 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 -1 if the character does not occur. |
indexOf | 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. |
indexOf | 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 for which:
k >= Math.min(fromIndex, this.length()) && this.startsWith(str, k)
If no such value of k exists, then -1 is returned.
Parameters: str - the substring for which to search. Parameters: fromIndex - the index from which to start the search. the index within this string of the first occurrence of thespecified substring, starting at the specified index. |
indexOf | static int indexOf(char[] source, int sourceOffset, int sourceCount, char[] target, int targetOffset, int targetCount, int fromIndex)(Code) | | Code shared by String and StringBuffer to do searches. The
source is the character array being searched, and the target
is the string being searched for.
Parameters: source - the characters being searched. Parameters: sourceOffset - offset of the source string. Parameters: sourceCount - count of the source string. Parameters: target - the characters being searched for. Parameters: targetOffset - offset of the target string. Parameters: targetCount - count of the target string. Parameters: fromIndex - the index to begin searching from. |
intern | native public String intern()(Code) | | Returns a canonical representation for the string object.
A pool of strings, initially empty, is maintained privately by the
class String .
When the intern method is invoked, if the pool already contains a
string equal to this String object as determined by
the
String.equals(Object) method, then the string from the pool is
returned. Otherwise, this String object is added to the
pool and a reference to this String object is returned.
It follows that for any two strings s and t ,
s.intern() == t.intern() is true
if and only if s.equals(t) is true .
All literal strings and string-valued constant expressions are
interned. String literals are defined in §3.10.5 of the
Java Language
Specification
a string that has the same contents as this string, but isguaranteed to be from a pool of unique strings. |
lastIndexOf | public int lastIndexOf(int ch)(Code) | | Returns the index within this string of the last occurrence of
the specified character. For values of ch in the
range from 0 to 0xFFFF (inclusive), the index (in Unicode code
units) returned is the largest value k such that:
this.charAt(k) == ch
is true. For other values of ch , it is the
largest value k such that:
this.codePointAt(k) == ch
is true. In either case, if no such character occurs in this
string, then -1 is returned. The
String is searched backwards starting at the last
character.
Parameters: ch - a character (Unicode code point). 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 | 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. For values of ch in the range
from 0 to 0xFFFF (inclusive), the index returned is the largest
value k such that:
(this.charAt(k) == ch) && (k <= fromIndex)
is true. For other values of ch , it is the
largest value k such that:
(this.codePointAt(k) == ch) && (k <= fromIndex)
is true. In either case, if no such character occurs in this
string at or before position fromIndex , then
-1 is returned.
All indices are specified in char values
(Unicode code units).
Parameters: ch - a character (Unicode code point). 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 -1 if the character does not occur before that point. |
lastIndexOf | 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. |
lastIndexOf | public int lastIndexOf(String str, int fromIndex)(Code) | | Returns the index within this string of the last occurrence of the
specified substring, searching backward starting at the specified index.
The integer returned is the largest value k such that:
k <= Math.min(fromIndex, this.length()) && this.startsWith(str, k)
If no such value of k exists, then -1 is returned.
Parameters: str - the substring to search for. Parameters: fromIndex - the index to start the search from. the index within this string of the last occurrence of thespecified substring. |
lastIndexOf | static int lastIndexOf(char[] source, int sourceOffset, int sourceCount, char[] target, int targetOffset, int targetCount, int fromIndex)(Code) | | Code shared by String and StringBuffer to do searches. The
source is the character array being searched, and the target
is the string being searched for.
Parameters: source - the characters being searched. Parameters: sourceOffset - offset of the source string. Parameters: sourceCount - count of the source string. Parameters: target - the characters being searched for. Parameters: targetOffset - offset of the target string. Parameters: targetCount - count of the target string. Parameters: fromIndex - the index to begin searching from. |
length | public int length()(Code) | | Returns the length of this string.
The length is equal to the number of Unicode
code units in the string.
the length of the sequence of characters represented by thisobject. |
offsetByCodePoints | public int offsetByCodePoints(int index, int codePointOffset)(Code) | | Returns the index within this String that is
offset from the given index by
codePointOffset code points. Unpaired surrogates
within the text range given by index and
codePointOffset count as one code point each.
Parameters: index - the index to be offset Parameters: codePointOffset - the offset in code points the index within this String exception: IndexOutOfBoundsException - if index is negative or larger then the length of thisString , or if codePointOffset is positiveand the substring starting with index has fewerthan codePointOffset code points,or if codePointOffset is negative and the substringbefore index has fewer than the absolute valueof codePointOffset code points. since: 1.5 |
regionMatches | public boolean regionMatches(int toffset, String other, int ooffset, int len)(Code) | | Tests if two string regions are equal.
A substring of this String object is compared to a substring
of the argument other. The result is true if these substrings
represent identical character sequences. The substring of this
String object to be compared begins at index toffset
and has length len. The substring of other to be compared
begins at index ooffset and has length len. The
result is false if and only if at least one of the following
is true:
- toffset is negative.
- ooffset is negative.
- toffset+len is greater than the length of this
String object.
- ooffset+len is greater than the length of the other
argument.
- There is some nonnegative integer k less than len
such that:
this.charAt(toffset+k) != other.charAt(ooffset+k)
Parameters: toffset - the starting offset of the subregion in this string. Parameters: other - the string argument. Parameters: ooffset - the starting offset of the subregion in the stringargument. Parameters: len - the number of characters to compare. true if the specified subregion of this stringexactly matches the specified subregion of the string argument;false otherwise. |
regionMatches | public boolean regionMatches(boolean ignoreCase, int toffset, String other, int ooffset, int len)(Code) | | Tests if two string regions are equal.
A substring of this String object is compared to a substring
of the argument other. The result is true if these
substrings represent character sequences that are the same, ignoring
case if and only if ignoreCase is true. The substring of
this String object to be compared begins at index
toffset and has length len. The substring of
other to be compared begins at index ooffset and
has length len. The result is false if and only if
at least one of the following is true:
- toffset is negative.
- ooffset is negative.
- toffset+len is greater than the length of this
String object.
- ooffset+len is greater than the length of the other
argument.
- ignoreCase is false and there is some nonnegative
integer k less than len such that:
this.charAt(toffset+k) != other.charAt(ooffset+k)
- ignoreCase is true and there is some nonnegative
integer k less than len such that:
Character.toLowerCase(this.charAt(toffset+k)) !=
Character.toLowerCase(other.charAt(ooffset+k))
and:
Character.toUpperCase(this.charAt(toffset+k)) !=
Character.toUpperCase(other.charAt(ooffset+k))
Parameters: ignoreCase - if true , ignore case when comparingcharacters. Parameters: toffset - the starting offset of the subregion in thisstring. Parameters: other - the string argument. Parameters: ooffset - the starting offset of the subregion in the stringargument. Parameters: len - the number of characters to compare. true if the specified subregion of this stringmatches the specified subregion of the string argument;false otherwise. Whether the matching is exactor case insensitive depends on the ignoreCase argument. |
replace | public String replace(char oldChar, char newChar)(Code) | | Returns a new string resulting from replacing all occurrences of
oldChar in this string with newChar .
If the character oldChar does not occur in the
character sequence represented by this String object,
then a reference to this String object is returned.
Otherwise, a new String object is created that
represents a character sequence identical to the character sequence
represented by this String object, except that every
occurrence of oldChar is replaced by an occurrence
of newChar .
Examples:
"mesquite in your cellar".replace('e', 'o')
returns "mosquito in your collar"
"the war of baronets".replace('r', 'y')
returns "the way of bayonets"
"sparring with a purple porpoise".replace('p', 't')
returns "starring with a turtle tortoise"
"JonL".replace('q', 'x') returns "JonL" (no change)
Parameters: oldChar - the old character. Parameters: newChar - the new character. a string derived from this string by replacing everyoccurrence of oldChar with newChar . |
replace | public String replace(CharSequence target, CharSequence replacement)(Code) | | Replaces each substring of this string that matches the literal target
sequence with the specified literal replacement sequence. The
replacement proceeds from the beginning of the string to the end, for
example, replacing "aa" with "b" in the string "aaa" will result in
"ba" rather than "ab".
Parameters: target - The sequence of char values to be replaced Parameters: replacement - The replacement sequence of char values The resulting string throws: NullPointerException - if target orreplacement is null . since: 1.5 |
split | public String[] split(String regex, int limit)(Code) | | Splits this string around matches of the given
regular expression.
The array returned by this method contains each substring of this
string that is terminated by another substring that matches the given
expression or is terminated by the end of the string. The substrings in
the array are in the order in which they occur in this string. If the
expression does not match any part of the input then the resulting array
has just one element, namely this string.
The limit parameter controls the number of times the
pattern is applied and therefore affects the length of the resulting
array. If the limit n is greater than zero then the pattern
will be applied at most n - 1 times, the array's
length will be no greater than n, and the array's last entry
will contain all input beyond the last matched delimiter. If n
is non-positive then the pattern will be applied as many times as
possible and the array can have any length. If n is zero then
the pattern will be applied as many times as possible, the array can
have any length, and trailing empty strings will be discarded.
The string "boo:and:foo", for example, yields the
following results with these parameters:
Regex |
Limit |
Result |
: |
2 |
{ "boo", "and:foo" } |
: |
5 |
{ "boo", "and", "foo" } |
: |
-2 |
{ "boo", "and", "foo" } |
o |
5 |
{ "b", "", ":and:f", "", "" } |
o |
-2 |
{ "b", "", ":and:f", "", "" } |
o |
0 |
{ "b", "", ":and:f" } |
An invocation of this method of the form
str.split(regex, n)
yields the same result as the expression
java.util.regex.Pattern .
java.util.regex.Pattern.compilecompile (regex).
java.util.regex.Pattern.split(java.lang.CharSequenceint)split (str, n)
Parameters: regex - the delimiting regular expression Parameters: limit - the result threshold, as described above the array of strings computed by splitting this stringaround matches of the given regular expression throws: PatternSyntaxException - if the regular expression's syntax is invalid See Also: java.util.regex.Pattern since: 1.4 |
split | public String[] split(String regex)(Code) | | Splits this string around matches of the given regular expression.
This method works as if by invoking the two-argument
String.split(String,int) split method with the given expression and a limit
argument of zero. Trailing empty strings are therefore not included in
the resulting array.
The string "boo:and:foo", for example, yields the following
results with these expressions:
Regex |
Result |
: |
{ "boo", "and", "foo" } |
o |
{ "b", "", ":and:f" } |
Parameters: regex - the delimiting regular expression the array of strings computed by splitting this stringaround matches of the given regular expression throws: PatternSyntaxException - if the regular expression's syntax is invalid See Also: java.util.regex.Pattern since: 1.4 |
startsWith | public boolean startsWith(String prefix, int toffset)(Code) | | Tests if the substring of this string beginning at the
specified index starts with the specified prefix.
Parameters: prefix - the prefix. Parameters: toffset - where to begin looking in this 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) |
startsWith | 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 theString.equals(Object) method. since: 1. 0 |
subSequence | public CharSequence subSequence(int beginIndex, int endIndex)(Code) | | Returns a new character sequence that is a subsequence of this sequence.
An invocation of this method of the form
str.subSequence(begin, end)
behaves in exactly the same way as the invocation
str.substring(begin, end)
This method is defined so that the String class can implement
the
CharSequence interface.
Parameters: beginIndex - the begin index, inclusive. Parameters: endIndex - the end index, exclusive. the specified subsequence. throws: IndexOutOfBoundsException - if beginIndex or endIndex are negative,if endIndex is greater than length(),or if beginIndex is greater than startIndex since: 1.4 |
substring | public String 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 | public String 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 .
Examples:
"hamburger".substring(4, 8) returns "urge"
"smiles".substring(1, 5) returns "mile"
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 . |
toCharArray | public char[] toCharArray()(Code) | | Converts this string to a new character array.
a newly allocated character array whose length is the lengthof this string and whose contents are initialized to containthe character sequence represented by this string. |
toLowerCase | public String toLowerCase()(Code) | | Converts all of the characters in this String to lower
case using the rules of the default locale. This is equivalent to calling
toLowerCase(Locale.getDefault()) .
Note: This method is locale sensitive, and may produce unexpected
results if used for strings that are intended to be interpreted locale
independently.
Examples are programming language identifiers, protocol keys, and HTML
tags.
For instance, "TITLE".toLowerCase() in a Turkish locale
returns "t\u0131tle" , where '\u0131' is the LATIN SMALL
LETTER DOTLESS I character.
To obtain correct results for locale insensitive strings, use
toLowerCase(Locale.ENGLISH) .
the String , converted to lowercase. See Also: java.lang.String.toLowerCase(Locale) |
toString | public String toString()(Code) | | This object (which is already a string!) is itself returned.
the string itself. |
toUpperCase | public String toUpperCase(Locale locale)(Code) | | Converts all of the characters in this String to upper
case using the rules of the given Locale . Case mapping is based
on the Unicode Standard version specified by the
java.lang.Character Character class. Since case mappings are not always 1:1 char mappings, the resulting
String may be a different length than the original String .
Examples of locale-sensitive and 1:M case mappings are in the following table.
Language Code of Locale |
Lower Case |
Upper Case |
Description |
tr (Turkish) |
\u0069 |
\u0130 |
small letter i -> capital letter I with dot above |
tr (Turkish) |
\u0131 |
\u0049 |
small letter dotless i -> capital letter I |
(all) |
\u00df |
\u0053 \u0053 |
small letter sharp s -> two letters: SS |
(all) |
Fahrvergnügen |
FAHRVERGNÜGEN |
|
Parameters: locale - use the case transformation rules for this locale the String , converted to uppercase. See Also: java.lang.String.toUpperCase See Also: java.lang.String.toLowerCase See Also: java.lang.String.toLowerCase(Locale) since: 1.1 |
toUpperCase | public String toUpperCase()(Code) | | Converts all of the characters in this String to upper
case using the rules of the default locale. This method is equivalent to
toUpperCase(Locale.getDefault()) .
Note: This method is locale sensitive, and may produce unexpected
results if used for strings that are intended to be interpreted locale
independently.
Examples are programming language identifiers, protocol keys, and HTML
tags.
For instance, "title".toUpperCase() in a Turkish locale
returns "T\u0130TLE" , where '\u0130' is the LATIN CAPITAL
LETTER I WITH DOT ABOVE character.
To obtain correct results for locale insensitive strings, use
toUpperCase(Locale.ENGLISH) .
the String , converted to uppercase. See Also: java.lang.String.toUpperCase(Locale) |
trim | public String trim()(Code) | | Returns a copy of the string, with leading and trailing whitespace
omitted.
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 (as defined above) from
the beginning and end of a string.
A copy of this string with leading and trailing whitespace removed, or this string if it has no leading ortrailing white space. |
valueOf | public static String valueOf(Object obj)(Code) | | Returns the string representation of the Object argument.
Parameters: obj - an Object . if the argument is null , then a string equal to"null" ; otherwise, the value ofobj.toString() is returned. See Also: java.lang.Object.toString |
valueOf | public static String valueOf(char data)(Code) | | Returns the string representation of the char array
argument. The contents of the character array are copied; subsequent
modification of the character array does not affect the newly
created string.
Parameters: data - a char array. a newly allocated string representing the same sequence ofcharacters contained in the character array argument. |
valueOf | public static String valueOf(char data, int offset, int count)(Code) | | Returns the string representation of a specific subarray of the
char array argument.
The offset argument is the index of the first
character of the subarray. The count argument
specifies the length of the subarray. The contents of the subarray
are copied; subsequent modification of the character array does not
affect the newly created string.
Parameters: data - the character array. Parameters: offset - the initial offset into the value of theString . Parameters: count - the length of the value of the String . a string representing the sequence of characters containedin the subarray of the character array argument. exception: IndexOutOfBoundsException - if offset isnegative, or count is negative, oroffset+count is larger thandata.length . |
valueOf | public static String valueOf(boolean b)(Code) | | Returns the string representation of the boolean argument.
Parameters: b - a boolean . if the argument is true , a string equal to"true" is returned; otherwise, a string equal to"false" is returned. |
valueOf | public static String valueOf(char c)(Code) | | Returns the string representation of the char
argument.
Parameters: c - a char . a string of length 1 containingas its single character the argument c . |
valueOf | public static String valueOf(int i)(Code) | | Returns the string representation of the int argument.
The representation is exactly the one returned by the
Integer.toString method of one argument.
Parameters: i - an int . a string representation of the int argument. See Also: java.lang.Integer.toString(intint) |
valueOf | public static String valueOf(long l)(Code) | | Returns the string representation of the long argument.
The representation is exactly the one returned by the
Long.toString method of one argument.
Parameters: l - a long . a string representation of the long argument. See Also: java.lang.Long.toString(long) |
valueOf | public static String valueOf(float f)(Code) | | Returns the string representation of the float argument.
The representation is exactly the one returned by the
Float.toString method of one argument.
Parameters: f - a float . a string representation of the float argument. See Also: java.lang.Float.toString(float) |
valueOf | public static String valueOf(double d)(Code) | | Returns the string representation of the double argument.
The representation is exactly the one returned by the
Double.toString method of one argument.
Parameters: d - a double . a string representation of the double argument. See Also: java.lang.Double.toString(double) |
|
|