| [ Web Proxy ] |
| Viewing: https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html | [Back] [Original] |
Serializable, CharSequence, Comparable<String>, Constable, ConstantDescString 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 Character class.
The Java language provides special support for the string concatenation operator ( + ), and for conversion of other objects to strings. For additional information on string concatenation and conversion, see 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).
Unless otherwise noted, methods for comparing Strings do not take locale
into account. The Collator class provides methods for
finer-grain, locale-sensitive String comparison.
javac compiler
may implement the operator with StringBuffer, StringBuilder,
or java.lang.invoke.StringConcatFactory depending on the JDK version. The
implementation of string conversion is typically through the method toString,
defined by Object and inherited by all classes in Java.Object.toString(),
StringBuffer,
StringBuilder,
Charset,
Serialized Formstatic Comparator<String>String objects as by
compareToIgnoreCase.String()String object so that it represents
an empty character sequence.String(byte[] bytes)String by decoding the specified array of bytes
using the platform's default charset.String(byte[] ascii,
int hibyte)String(byte[] bytes,
int offset,
int length)String by decoding the specified subarray of
bytes using the platform's default charset.String(byte[] ascii,
int hibyte,
int offset,
int count)String by decoding the specified subarray of
bytes using the specified charset.String by decoding the specified subarray of
bytes using the specified charset.String by decoding the specified array of bytes
using the specified charset.String by decoding the specified array of
bytes using the specified charset.String(char[] value)String so that it represents the sequence of
characters currently contained in the character array argument.String(char[] value,
int offset,
int count)String that contains characters from a subarray
of the character array argument.String(int[] codePoints,
int offset,
int count)String that contains characters from a subarray
of the Unicode code point array
argument.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.String(StringBuffer buffer)String(StringBuilder builder)charcharAt(int index)char value at the
specified index.chars()int zero-extending the char values
from this sequence.intcodePointAt(int index)intcodePointBefore(int index)intcodePointCount(int beginIndex,
int endIndex)String.intintcompareToIgnoreCase(String str)booleancontains(CharSequence s)booleanCharSequence.booleanStringBuffer.static StringcopyValueOf(char[] data)valueOf(char[]).static StringcopyValueOf(char[] data,
int offset,
int count)valueOf(char[], int, int).Optional containing the nominal descriptor for this
instance, which is the instance itself.booleanbooleanbooleanequalsIgnoreCase(String anotherString)String to another String, ignoring case
considerations.static Stringstatic Stringbyte[]getBytes()String into a sequence of bytes using the
platform's default charset, storing the result into a new byte array.voidgetBytes(int srcBegin,
int srcEnd,
byte[] dst,
int dstBegin)byte[]String into a sequence of bytes using the named
charset, storing the result into a new byte array.byte[]String into a sequence of bytes using the given
charset, storing the result into a
new byte array.voidgetChars(int srcBegin,
int srcEnd,
char[] dst,
int dstBegin)inthashCode()indent(int n)n, and normalizes line termination characters.intindexOf(int ch)intindexOf(int ch,
int fromIndex)intintintern()booleanisBlank()booleanisEmpty()static Stringjoin(CharSequence delimiter,
CharSequence... elements)CharSequence elements joined together with a copy of
the specified delimiter.static Stringjoin(CharSequence delimiter,
Iterable<? extends CharSequence> elements)String composed of copies of the
CharSequence elements joined together with a copy of the
specified delimiter.intlastIndexOf(int ch)intlastIndexOf(int ch,
int fromIndex)intlastIndexOf(String str)intlastIndexOf(String str,
int fromIndex)intlength()lines()booleanintoffsetByCodePoints(int index,
int codePointOffset)String that is
offset from the given index by
codePointOffset code points.booleanregionMatches(boolean ignoreCase,
int toffset,
String other,
int ooffset,
int len)booleanregionMatches(int toffset,
String other,
int ooffset,
int len)repeat(int count)count times.replace(char oldChar,
char newChar)oldChar in this string with newChar.replace(CharSequence target,
CharSequence replacement)replaceAll(String regex,
String replacement)replaceFirst(String regex,
String replacement)resolveConstantDesc(MethodHandles.Lookup lookup)ConstantDesc, the result of which is
the instance itself.String[]String[]booleanstartsWith(String prefix)booleanstartsWith(String prefix,
int toffset)strip()subSequence(int beginIndex,
int endIndex)substring(int beginIndex)substring(int beginIndex,
int endIndex)char[]String to lower
case using the rules of the default locale.toLowerCase(Locale locale)String to lower
case using the rules of the given Locale.toString()String to upper
case using the rules of the default locale.toUpperCase(Locale locale)String to upper
case using the rules of the given Locale.<R> Rthis
string.trim()'U+0020' (the space character).static StringvalueOf(boolean b)boolean argument.static StringvalueOf(char c)char
argument.static StringvalueOf(char[] data)char array
argument.static StringvalueOf(char[] data,
int offset,
int count)char array argument.static StringvalueOf(double d)double argument.static StringvalueOf(float f)float argument.static StringvalueOf(int i)int argument.static StringvalueOf(long l)long argument.static StringObject argument.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 Collator class provides locale-sensitive comparison.
CollatorString object so that it represents
an empty character sequence. Note that use of this constructor is
unnecessary since Strings are immutable.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.original - A StringString 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.value - The initial value of the stringString 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.value - Array that is the source of charactersoffset - The initial offsetcount - The lengthIndexOutOfBoundsException - If offset is negative, count is negative, or
offset is greater than value.length - countString 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
chars; subsequent modification of the int array does not
affect the newly created string.codePoints - Array that is the source of Unicode code pointsoffset - The initial offsetcount - The lengthIllegalArgumentException - If any invalid Unicode code point is found in
codePointsIndexOutOfBoundsException - If offset is negative, count is negative, or
offset is greater than codePoints.length - countString constructors that take a Charset, charset name, or that use the platform's
default charset.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 String(byte[],int) constructor.
ascii - The bytes to be converted to charactershibyte - The top 8 bits of each 16-bit Unicode code unitoffset - The initial offsetcount - The lengthIndexOutOfBoundsException - If offset is negative, count is negative, or
offset is greater than ascii.length - countString(byte[], int),
String(byte[], int, int, java.lang.String),
String(byte[], int, int, java.nio.charset.Charset),
String(byte[], int, int),
String(byte[], java.lang.String),
String(byte[], java.nio.charset.Charset),
String(byte[])String constructors that take a Charset, charset name, or that use the platform's
default charset.String containing characters constructed from
an array of 8-bit integer values. Each character c in the
resulting string is constructed from the corresponding component
b in the byte array such that:
c == (char)(((hibyte & 0xff) << 8)
| (b & 0xff))
ascii - The bytes to be converted to charactershibyte - The top 8 bits of each 16-bit Unicode code unitString(byte[], int, int, java.lang.String),
String(byte[], int, int, java.nio.charset.Charset),
String(byte[], int, int),
String(byte[], java.lang.String),
String(byte[], java.nio.charset.Charset),
String(byte[])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 CharsetDecoder class should be used when more control
over the decoding process is required.
bytes - The bytes to be decoded into charactersoffset - The index of the first byte to decodelength - The number of bytes to decodecharsetName - The name of a supported charsetUnsupportedEncodingException - If the named charset is not supportedIndexOutOfBoundsException - If offset is negative, length is negative, or
offset is greater than bytes.length - lengthString 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.
This method always replaces malformed-input and unmappable-character
sequences with this charset's default replacement string. The CharsetDecoder class should be used when more control
over the decoding process is required.
bytes - The bytes to be decoded into charactersoffset - The index of the first byte to decodelength - The number of bytes to decodecharset - The charset to be used to
decode the bytesIndexOutOfBoundsException - If offset is negative, length is negative, or
offset is greater than bytes.length - lengthString by decoding the specified array 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 byte array.
The behavior of this constructor when the given bytes are not valid
in the given charset is unspecified. The CharsetDecoder class should be used when more control
over the decoding process is required.
bytes - The bytes to be decoded into characterscharsetName - The name of a supported charsetUnsupportedEncodingException - If the named charset is not supportedString by decoding the specified array 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 byte array.
This method always replaces malformed-input and unmappable-character
sequences with this charset's default replacement string. The CharsetDecoder class should be used when more control
over the decoding process is required.
bytes - The bytes to be decoded into characterscharset - The charset to be used to
decode the bytesString 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 CharsetDecoder class should be used when more control
over the decoding process is required.
bytes - The bytes to be decoded into charactersoffset - The index of the first byte to decodelength - The number of bytes to decodeIndexOutOfBoundsException - If offset is negative, length is negative, or
offset is greater than bytes.length - lengthString 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 CharsetDecoder class should be used when more control
over the decoding process is required.
bytes - The bytes to be decoded into charactersbuffer - A StringBuffer 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.
builder - A StringBuilderlength in interface CharSequenceisEmpty in interface CharSequencetrue if length() is 0, otherwise
falsechar 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.
charAt in interface CharSequenceindex - the index of the char value.char value at the specified index of this string.
The first char value is at index 0.IndexOutOfBoundsException - if the index
argument is negative or not less than the length of this
string.char values
(Unicode code units) and ranges from 0 to
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.
index - the index to the char valuesindexIndexOutOfBoundsException - if the index
argument is negative or not less than the length of this
string.char values
(Unicode code units) and ranges from 1 to 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.
index - the index following the code point that should be returnedIndexOutOfBoundsException - if the index
argument is less than 1 or greater than the length
of this string.String. The text range begins at the
specified beginIndex and extends to the
char at index endIndex - 1. Thus the
length (in chars) of the text range is
endIndex-beginIndex. Unpaired surrogates within
the text range count as one code point each.beginIndex - the index to the first char of
the text range.endIndex - the index after the last char of
the text range.IndexOutOfBoundsException - if the
beginIndex is negative, or endIndex
is larger than the length of this String, or
beginIndex is larger than endIndex.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.index - the index to be offsetcodePointOffset - the offset in code pointsStringIndexOutOfBoundsException - if index
is negative or larger then the length of this
String, or if codePointOffset is positive
and the substring starting with index has fewer
than codePointOffset code points,
or if codePointOffset is negative and the substring
before index has fewer than the absolute value
of codePointOffset code points.
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
srcBegin - index of the first character in the string
to copy.srcEnd - index after the last character in the string
to copy.dst - the destination array.dstBegin - the start offset in the destination array.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.lengthgetBytes() method, which uses the platform's default charset. 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
srcBegin - Index of the first character in the string to copysrcEnd - Index after the last character in the string to copydst - The destination arraydstBegin - The start offset in the destination arrayIndexOutOfBoundsException - 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
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 CharsetEncoder class should be used when more control
over the encoding process is required.
charsetName - The name of a supported charsetUnsupportedEncodingException - If the named charset is not supportedString into a sequence of bytes using the given
charset, 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
CharsetEncoder class should be used when more
control over the encoding process is required.
charset - The Charset to be used to encode
the StringString 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 CharsetEncoder class should be used when more control
over the encoding process is required.
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.
For finer-grained String comparison, refer to
Collator.
equals in class ObjectanObject - The object to compare this String againsttrue if the given object represents a String
equivalent to this string, false otherwisecompareTo(String),
equalsIgnoreCase(String)StringBuffer. The result
is true if and only if this String represents the same
sequence of characters as the specified StringBuffer. This method
synchronizes on the StringBuffer.
For finer-grained String comparison, refer to
Collator.
sb - The StringBuffer to compare this String againsttrue if this String represents the same
sequence of characters as the specified StringBuffer,
false otherwiseCharSequence. The
result is true if and only if this String represents the
same sequence of char values as the specified sequence. Note that if the
CharSequence is a StringBuffer then the method
synchronizes on it.
For finer-grained String comparison, refer to
Collator.
cs - The sequence to compare this String againsttrue if this String represents the same
sequence of char values as the specified sequence,
false otherwiseString to another String, ignoring case
considerations. Two strings are considered equal ignoring case if they
are of the same length and corresponding Unicode code points in the two
strings are equal ignoring case.
Two Unicode code points are considered the same ignoring case if at least one of the following is true:
== operator)
Character.toLowerCase(Character.toUpperCase(int))
on each Unicode code point produces the same result
Note that this method does not take locale into account, and
will result in unsatisfactory results for certain locales. The
Collator class provides locale-sensitive comparison.
anotherString - The String to compare this String againsttrue if the argument is not null and it
represents an equivalent String ignoring case;
false otherwiseequals(Object),
codePoints()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 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:
If there is no index position at which they differ, then the shorter string lexicographically precedes the longer string. In this case,this.charAt(k)-anotherString.charAt(k)
compareTo returns the difference of the lengths of the
strings -- that is, the value:
this.length()-anotherString.length()
For finer-grained String comparison, refer to
Collator.
compareTo in interface Comparable<String>anotherString - the String to be compared.0 if the argument string is equal to
this string; a value less than 0 if this string
is lexicographically less than the string argument; and a
value greater than 0 if this string is
lexicographically greater than the string argument.compareTo with case folded versions of the strings
where case differences have been eliminated by calling
Character.toLowerCase(Character.toUpperCase(int)) on
each Unicode code point.
Note that this method does not take locale into account,
and will result in an unsatisfactory ordering for certain locales.
The Collator class provides locale-sensitive comparison.
str - the String to be compared.Collator,
codePoints()
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.
len
such that:
this.charAt(toffset + k) != other.charAt(ooffset +
k)
Note that this method does not take locale into account. The
Collator class provides locale-sensitive comparison.
toffset - the starting offset of the subregion in this string.other - the string argument.ooffset - the starting offset of the subregion in the string
argument.len - the number of characters to compare.true if the specified subregion of this string
exactly matches the specified subregion of the string argument;
false otherwise.
A substring of this String object is compared to a substring
of the argument other. The result is true if these
substrings represent Unicode code point sequences that are the same,
ignoring case if and only if ignoreCase is true.
The sequences tsequence and osequence are compared,
where tsequence is the sequence produced as if by calling
this.substring(toffset, len).codePoints() and osequence
is the sequence produced as if by calling
other.substring(ooffset, len).codePoints().
The result is true if and only if all of the following
are true:
toffset is non-negative.
ooffset is non-negative.
toffset+len is less than or equal to the length of this
String object.
ooffset+len is less than or equal to the length of the other
argument.
ignoreCase is false, all pairs of corresponding Unicode
code points are equal integer values; or if ignoreCase is true,
Character.toLowerCase(
Character.toUpperCase(int)) on all pairs of Unicode code points
results in equal integer values.
Note that this method does not take locale into account,
and will result in unsatisfactory results for certain locales when
ignoreCase is true. The Collator class
provides locale-sensitive comparison.
ignoreCase - if true, ignore case when comparing
characters.toffset - the starting offset of the subregion in this
string.other - the string argument.ooffset - the starting offset of the subregion in the string
argument.len - the number of characters (Unicode code units -
16bit char value) to compare.true if the specified subregion of this string
matches the specified subregion of the string argument;
false otherwise. Whether the matching is exact
or case insensitive depends on the ignoreCase
argument.codePoints()prefix - the prefix.toffset - where to begin looking in this string.true if the character sequence represented by the
argument is a prefix of the substring of this object starting
at index toffset; false otherwise.
The result is false if toffset is
negative or greater than the length of this
String object; otherwise the result is the same
as the result of the expression
this.substring(toffset).startsWith(prefix)
prefix - the prefix.true if the character sequence represented by the
argument is a prefix of the character sequence represented by
this string; false otherwise.
Note also that true will be returned if the
argument is an empty string or is equal to this
String object as determined by the
equals(Object) method.suffix - the suffix.true if the character sequence represented by the
argument is a suffix of the character sequence represented by
this object; false otherwise. Note that the
result will be true if the argument is the
empty string or is equal to this String object
as determined by the equals(Object) method.String object is computed as
usings[0]*31^(n-1) + s[1]*31^(n-2) + ... + s[n-1]
int arithmetic, where s[i] is the
ith character of the string, n is the length of
the string, and ^ indicates exponentiation.
(The hash value of the empty string is zero.)hashCode in class ObjectObject.equals(java.lang.Object),
System.identityHashCode(java.lang.Object)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:
is true. For other values ofthis.charAt(k) == ch
ch, it is the
smallest value k such that:
is true. In either case, if no such character occurs in this string, thenthis.codePointAt(k) == ch
-1 is returned.ch - a character (Unicode code point).-1 if the character does not occur.
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:
is true. For other values of(this.charAt(k) == ch)&&(k >= fromIndex)
ch, it is the
smallest value k such that:
is true. In either case, if no such character occurs in this string at or after position(this.codePointAt(k) == ch)&&(k >= fromIndex)
fromIndex, then
-1 is returned.
There is no restriction on the value of fromIndex. If it
is negative, it has the same effect as if it were zero: this entire
string may be searched. If it is greater than the length of this
string, it has the same effect as if it were equal to the length of
this string: -1 is returned.
All indices are specified in char values
(Unicode code units).
ch - a character (Unicode code point).fromIndex - the index to start the search from.fromIndex, or -1
if the character does not occur.ch in the
range from 0 to 0xFFFF (inclusive), the index (in Unicode code
units) returned is the largest value k such that:
is true. For other values ofthis.charAt(k) == ch
ch, it is the
largest value k such that:
is true. In either case, if no such character occurs in this string, thenthis.codePointAt(k) == ch
-1 is returned. The
String is searched backwards starting at the last
character.ch - a character (Unicode code point).-1 if the character does not occur.ch in the range
from 0 to 0xFFFF (inclusive), the index returned is the largest
value k such that:
is true. For other values of(this.charAt(k) == ch)&&(k <= fromIndex)
ch, it is the
largest value k such that:
is true. In either case, if no such character occurs in this string at or before position(this.codePointAt(k) == ch)&&(k <= fromIndex)
fromIndex, then
-1 is returned.
All indices are specified in char values
(Unicode code units).
ch - a character (Unicode code point).fromIndex - the index to start the search from. There is no
restriction on the value of fromIndex. If it is
greater than or equal to the length of this string, it has
the same effect as if it were equal to one less than the
length of this string: this entire string may be searched.
If it is negative, it has the same effect as if it were -1:
-1 is returned.fromIndex, or -1
if the character does not occur before that point.The returned index is the smallest value k for which:
this.startsWith(str, k)
If no such value of k exists, then -1 is returned.str - the substring to search for.-1 if there is no such occurrence.The returned index 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.str - the substring to search for.fromIndex - the index from which to start the search.-1 if there is no such occurrence.this.length().
The returned index is the largest value k for which:
this.startsWith(str, k)
If no such value of k exists, then -1 is returned.str - the substring to search for.-1 if there is no such occurrence.The returned index is the largest 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.str - the substring to search for.fromIndex - the index to start the search from.-1 if there is no such occurrence.Examples:
"unhappy".substring(2) returns "happy" "Harbison".substring(3) returns "bison" "emptiness".substring(9) returns "" (an empty string)
beginIndex - the beginning index, inclusive.IndexOutOfBoundsException - if
beginIndex is negative or larger than the
length of this String object.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"
beginIndex - the beginning index, inclusive.endIndex - the ending index, exclusive.IndexOutOfBoundsException - if the
beginIndex is negative, or
endIndex is larger than the length of
this String object, or
beginIndex is larger than
endIndex.An invocation of this method of the form
behaves in exactly the same way as the invocationstr.subSequence(begin, end)
str.substring(begin, end)
subSequence in interface CharSequenceString class can implement
the CharSequence interface.beginIndex - the begin index, inclusive.endIndex - the end index, exclusive.IndexOutOfBoundsException - if beginIndex or endIndex is negative,
if endIndex is greater than length(),
or if beginIndex is greater than endIndex
If the length of the argument string is 0, then this
String object is returned. Otherwise, a
String object is returned that represents 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"
str - the String that is concatenated to the end
of this String.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 String object is returned 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)
oldChar - the old character.newChar - the new character.oldChar with newChar. An invocation of this method of the form
str.matches(regex) yields exactly the
same result as the expression
Pattern.matches(regex, str)
regex - the regular expression to which this string is to be matchedtrue if, and only if, this string matches the
given regular expressionPatternSyntaxException - if the regular expression's syntax is invalidPatterns - the sequence to search fors, false otherwise An invocation of this method of the form
str.replaceFirst(regex, repl)
yields exactly the same result as the expression
Pattern.compile(regex).matcher(str).replaceFirst(repl)
Note that backslashes (\) and dollar signs ($) in the
replacement string may cause the results to be different than if it were
being treated as a literal replacement string; see
Matcher.replaceFirst(java.lang.String).
Use Matcher.quoteReplacement(java.lang.String) to suppress the special
meaning of these characters, if desired.
regex - the regular expression to which this string is to be matchedreplacement - the string to be substituted for the first matchStringPatternSyntaxException - if the regular expression's syntax is invalidPattern An invocation of this method of the form
str.replaceAll(regex, repl)
yields exactly the same result as the expression
Pattern.compile(regex).matcher(str).replaceAll(repl)
Note that backslashes (\) and dollar signs ($) in the
replacement string may cause the results to be different than if it were
being treated as a literal replacement string; see
Matcher.replaceAll.
Use Matcher.quoteReplacement(java.lang.String) to suppress the special
meaning of these characters, if desired.
regex - the regular expression to which this string is to be matchedreplacement - the string to be substituted for each matchStringPatternSyntaxException - if the regular expression's syntax is invalidPatterntarget - The sequence of char values to be replacedreplacement - The replacement sequence of char valuesThe 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.
When there is a positive-width match at the beginning of this string then an empty leading substring is included at the beginning of the resulting array. A zero-width match at the beginning however never produces such empty leading substring.
The limit parameter controls the number of times the
pattern is applied and therefore affects the length of the resulting
array.
If the limit is positive then the pattern will be applied at most limit - 1 times, the array's length will be no greater than limit, and the array's last entry will contain all input beyond the last matched delimiter.
If the limit 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.
If the limit is negative then the pattern will be applied as many times as possible and the array can have any length.
The string "boo:and:foo", for example, yields the
following results with these parameters:
Split example showing regex, limit, and result Regex Limit Result : 2 { "boo", "and:foo" }5 { "boo", "and", "foo" }-2 { "boo", "and", "foo" }o 5 { "b", "", ":and:f", "", "" }-2 { "b", "", ":and:f", "", "" }0 { "b", "", ":and:f" }
An invocation of this method of the form
str.split(regex, n)
yields the same result as the expression
Pattern.compile(regex).split(str, n)
regex - the delimiting regular expressionlimit - the result threshold, as described abovePatternSyntaxException - if the regular expression's syntax is invalidPattern This method works as if by invoking the two-argument 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:
Split examples showing regex and result Regex Result : { "boo", "and", "foo" }o { "b", "", ":and:f" }
regex - the delimiting regular expressionPatternSyntaxException - if the regular expression's syntax is invalidPatternCharSequence elements joined together with a copy of
the specified delimiter.
For example,Note that if an element is null, thenString message = String.join("-", "Java", "is", "cool"); // message returned is: "Java-is-cool"
"null" is added.delimiter - the delimiter that separates each elementelements - the elements to join together.String that is composed of the elements
separated by the delimiterNullPointerException - If delimiter or elements
is nullStringJoinerString composed of copies of the
CharSequence elements joined together with a copy of the
specified delimiter.
For example,Note that if an individual element isList<String> strings = List.of("Java", "is", "cool"); String message = String.join(" ", strings); // message returned is: "Java is cool" Set<String> strings = new LinkedHashSet<>(List.of("Java", "is", "very", "cool")); String message = String.join("-", strings); // message returned is: "Java-is-very-cool"
null, then "null" is added.delimiter - a sequence of characters that is used to separate each
of the elements in the resulting Stringelements - an Iterable that will have its elements
joined together.String that is composed from the elements
argumentNullPointerException - If delimiter or elements
is nulljoin(CharSequence,CharSequence...),
StringJoinerString to lower
case using the rules of the given Locale. Case mapping is based
on the Unicode Standard version specified by the 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 lowercase mappings are in the following table:
| Language Code of Locale | Upper Case | Lower Case | Description |
|---|---|---|---|
| tr (Turkish) | \u0130 | \u0069 | capital letter I with dot above -> small letter i |
| tr (Turkish) | \u0049 | \u0131 | capital letter I -> small letter dotless i |
| (all) | French Fries | french fries | lowercased all chars in String |
| (all) | ΙΧΘΥΣ | ιχθυσ | lowercased all chars in String |
locale - use the case transformation rules for this localeString, converted to lowercase.toLowerCase(),
toUpperCase(),
toUpperCase(Locale)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.ROOT).
String, converted to lowercase.toLowerCase(Locale)String to upper
case using the rules of the given Locale. Case mapping is based
on the Unicode Standard version specified by the 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 |
locale - use the case transformation rules for this localeString, converted to uppercase.toUpperCase(),
toLowerCase(),
toLowerCase(Locale)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.ROOT).
String, converted to uppercase.toUpperCase(Locale)'U+0020' (the space character).
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
that are not space (as defined above), then a
reference to this String object is returned.
Otherwise, if all characters in this string are space (as
defined above), then a String object representing an
empty string is returned.
Otherwise, let k be the index of the first character in the
string whose code is not a space (as defined above) and let
m be the index of the last character in the string whose code
is not a space (as defined above). A String
object is returned, 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 space (as defined above) from the beginning and end of a string.
If this String object represents an empty string,
or if all code points in this string are
white space, then an empty string
is returned.
Otherwise, returns a substring of this string beginning with the first code point that is not a white space up to and including the last code point that is not a white space.
This method may be used to strip white space from the beginning and end of a string.
Character.isWhitespace(int)
If this String object represents an empty string,
or if all code points in this string are
white space, then an empty string
is returned.
Otherwise, returns a substring of this string beginning with the first code point that is not a white space up to and including the last code point of this string.
This method may be used to trim white space from the beginning of a string.
Character.isWhitespace(int)
If this String object represents an empty string,
or if all characters in this string are
white space, then an empty string
is returned.
Otherwise, returns a substring of this string beginning with the first code point of this string up to and including the last code point that is not a white space.
This method may be used to trim white space from the end of a string.
Character.isWhitespace(int)true if the string is empty or contains only
white space codepoints,
otherwise falseCharacter.isWhitespace(int)
A line terminator is one of the following:
a line feed character "\n" (U+000A),
a carriage return character "\r" (U+000D),
or a carriage return followed immediately by a line feed
"\r\n" (U+000D U+000A).
A line is either a sequence of zero or more characters followed by a line terminator, or it is a sequence of one or more characters followed by the end of the string. A line does not include the line terminator.
The stream returned by this method contains the lines from this string in the order in which they occur.
n, and normalizes line termination characters.
This string is conceptually separated into lines using
lines(). Each line is then adjusted as described below
and then suffixed with a line feed "\n" (U+000A). The resulting
lines are then concatenated and returned.
If n > 0 then n spaces (U+0020) are inserted at the
beginning of each line.
If n < 0 then up to n
white space characters are removed
from the beginning of each line. If a given line does not contain
sufficient white space then all leading
white space characters are removed.
Each white space character is treated as a single character. In
particular, the tab character "\t" (U+0009) is considered a
single character; it is not expanded.
If n == 0 then the line remains unchanged. However, line
terminators are still normalized.
n - number of leading
white space characters
to add or removelines(),
isBlank(),
Character.isWhitespace(int)Incidental white space is often present in a text block to align the content with the opening delimiter. For example, in the following code, dots represent incidental white space:
This method treats the incidental white space as indentation to be stripped, producing a string that preserves the relative indentation of the content. Using | to visualize the start of each line of the string:String html = """ ..............<html> .............. <body> .............. <p>Hello, world</p> .............. </body> ..............</html> ..............""";
First, the individual lines of this string are extracted. A line is a sequence of zero or more characters followed by either a line terminator or the end of the string. If the string has at least one line terminator, the last line consists of the characters between the last terminator and the end of the string. Otherwise, if the string has no terminators, the last line is the start of the string to the end of the string, in other words, the entire string. A line does not include the line terminator.|<html> | <body> | <p>Hello, world</p> | </body> |</html>
Then, the minimum indentation (min) is determined as follows:
For each non-blank line (as defined by isBlank()),
the leading white space
characters are counted.
The leading white space characters on the last line are also counted even if blank.
The min value is the smallest of these counts.
For each non-blank line, min leading white space characters are removed, and any trailing white space characters are removed. Blank lines are replaced with the empty string.
Finally, the lines are joined into a new string, using the LF character
"\n" (U+000A) to separate lines.
lines(),
isBlank(),
indent(int),
Character.isWhitespace(int)Escape sequences are translated as follows;
| Escape | Name | Translation |
|---|---|---|
\b |
backspace | U+0008 |
\t |
horizontal tab | U+0009 |
\n |
line feed | U+000A |
\f |
form feed | U+000C |
\r |
carriage return | U+000D |
\s |
space | U+0020 |
\" |
double quote | U+0022 |
\' |
single quote | U+0027 |
\\ |
backslash | U+005C |
\0 - \377 |
octal escape | code point equivalents |
\<line-terminator> |
continuation | discard |
\u2022".
Unicode escapes are translated by the Java compiler when reading input characters and
are not part of the string literal specification.IllegalArgumentException - when an escape sequence is malformed.this
string. The function should expect a single String argument
and produce an R result.
Any exception thrown by f.apply() will be propagated to the
caller.
R - the type of the resultf - a function to applyFunctiontoString in interface CharSequencetoString in class Objectint zero-extending the char values
from this sequence. Any char which maps to a surrogate code
point is passed through uninterpreted.chars in interface CharSequenceint values which are then passed to the stream.codePoints in interface CharSequence The locale always used is the one returned by Locale.getDefault(Locale.Category) with
FORMAT category specified.
format - A format stringargs - Arguments referenced by the format specifiers in the format
string. If there are more arguments than format specifiers, the
extra arguments are ignored. The number of arguments is
variable and may be zero. The maximum number of arguments is
limited by the maximum dimension of a Java array as defined by
The Java Virtual Machine Specification.
The behaviour on a
null argument depends on the conversion.IllegalFormatException - If a format string contains an illegal syntax, a format
specifier that is incompatible with the given arguments,
insufficient arguments given the format string, or other
illegal conditions. For specification of all possible
formatting errors, see the Details section of the
formatter class specification.Formatterl - The locale to apply during
formatting. If l is null then no localization
is applied.format - A format stringargs - Arguments referenced by the format specifiers in the format
string. If there are more arguments than format specifiers, the
extra arguments are ignored. The number of arguments is
variable and may be zero. The maximum number of arguments is
limited by the maximum dimension of a Java array as defined by
The Java Virtual Machine Specification.
The behaviour on a
null argument depends on the
conversion.IllegalFormatException - If a format string contains an illegal syntax, a format
specifier that is incompatible with the given arguments,
insufficient arguments given the format string, or other
illegal conditions. For specification of all possible
formatting errors, see the Details section of the
formatter class specificationFormatterString.format(this, args).args - Arguments referenced by the format specifiers in this string.format(String,Object...),
FormatterObject argument.obj - an Object.null, then a string equal to
"null"; otherwise, the value of
obj.toString() is returned.Object.toString()char array
argument. The contents of the character array are copied; subsequent
modification of the character array does not affect the returned
string.data - the character array.String that contains the characters of the
character array.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 returned string.
data - the character array.offset - initial offset of the subarray.count - length of the subarray.String that contains the characters of the
specified subarray of the character array.IndexOutOfBoundsException - if offset is
negative, or count is negative, or
offset+count is larger than
data.length.valueOf(char[], int, int).data - the character array.offset - initial offset of the subarray.count - length of the subarray.String that contains the characters of the
specified subarray of the character array.IndexOutOfBoundsException - if offset is
negative, or count is negative, or
offset+count is larger than
data.length.valueOf(char[]).data - the character array.String that contains the characters of the
character array.boolean argument.b - a boolean.true, a string equal to
"true" is returned; otherwise, a string equal to
"false" is returned.char
argument.c - a char.1 containing
as its single character the argument c.int argument.
The representation is exactly the one returned by the
Integer.toString method of one argument.
i - an int.int argument.Integer.toString(int, int)long argument.
The representation is exactly the one returned by the
Long.toString method of one argument.
l - a long.long argument.Long.toString(long)float argument.
The representation is exactly the one returned by the
Float.toString method of one argument.
f - a float.float argument.Float.toString(float)double argument.
The representation is exactly the one returned by the
Double.toString method of one argument.
d - a double.double argument.Double.toString(double)
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 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 section 3.10.5 of the The Java Language Specification.
count times.
If this string is empty or count is zero then the empty string is returned.
count - number of times to repeatcount times or the empty string if this
string is empty or count is zeroIllegalArgumentException - if the count is
negative.Optional containing the nominal descriptor for this
instance, which is the instance itself.describeConstable in interface ConstableOptional describing the String instanceConstantDesc, the result of which is
the instance itself.resolveConstantDesc in interface ConstantDesclookup - ignoredReport a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2021, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.
| Web Proxy Viewer | New URL | Original Page |