String

public final class String extends Object
implements Serializable Comparable<String> CharSequence

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

See Also

• Object.toString()
• StringBuffer
• StringBuilder
• Charset

Field Summary

public static final Comparator<String>

CASE_INSENSITIVE_ORDER

A Comparator that orders String objects as by compareToIgnoreCase.

Public Constructor Summary

	String() Initializes a newly created String object so that it represents an empty character sequence.
	String(byte[] bytes) Constructs a new String by decoding the specified array of bytes using the platform's default charset.
	String(byte[] ascii, int hibyte) This constructor is deprecated. This method does not properly convert bytes into characters. As of JDK 1.1, the preferred way to do this is via the String constructors that take a Charset, charset name, or that use the platform's default charset.
	String(byte[] bytes, int offset, int length) Constructs a new String by decoding the specified subarray of bytes using the platform's default charset.
	String(byte[] ascii, int hibyte, int offset, int count) This constructor is deprecated. This method does not properly convert bytes into characters. As of JDK 1.1, the preferred way to do this is via the String constructors that take a Charset, charset name, or that use the platform's default charset.
	String(byte[] bytes, int offset, int length, String charsetName) Constructs a new String by decoding the specified subarray of bytes using the specified charset.
	String(byte[] bytes, int offset, int length, Charset charset) Constructs a new String by decoding the specified subarray of bytes using the specified {@linkplain java.nio.charset.Charset charset}.
	String(byte[] bytes, Charset charset) Constructs a new String by decoding the specified array of bytes using the specified {@linkplain java.nio.charset.Charset charset}.
	String(byte[] bytes, String charsetName) Constructs a new String by decoding the specified array of bytes using the specified {@linkplain java.nio.charset.Charset charset}.
	String(char[] value) Allocates a new String so that it represents the sequence of characters currently contained in the character array argument.
	String(char[] value, int offset, int count) Allocates a new String that contains characters from a subarray of the character array argument.
	String(int[] codePoints, int offset, int count) Allocates a new String that contains characters from a subarray of the Unicode code point array argument.
	String(String s) 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.
	String(StringBuffer buffer) Allocates a new string that contains the sequence of characters currently contained in the string buffer argument.
	String(StringBuilder builder) Allocates a new string that contains the sequence of characters currently contained in the string builder argument.

Public Method Summary

char	charAt(int index) Returns the char value at the specified index.
int	codePointAt(int index) Returns the character (Unicode code point) at the specified index.
int	codePointBefore(int index) Returns the character (Unicode code point) before the specified index.
int	codePointCount(int beginIndex, int endIndex) Returns the number of Unicode code points in the specified text range of this String.
int	compareTo(String anotherString) Compares two strings lexicographically.
int	compareToIgnoreCase(String str) Compares two strings lexicographically, ignoring case differences.
String	concat(String str) Concatenates the specified string to the end of this string.
boolean	contains(CharSequence s) Returns true if and only if this string contains the specified sequence of char values.
boolean	contentEquals(StringBuffer sb) Compares this string to the specified StringBuffer.
boolean	contentEquals(CharSequence cs) Compares this string to the specified CharSequence.
static String	copyValueOf(char[] data, int offset, int count) Equivalent to valueOf(char[], int, int).
static String	copyValueOf(char[] data) Equivalent to valueOf(char[]).
boolean	endsWith(String suffix) Tests if this string ends with the specified suffix.
boolean	equals(Object anObject) Compares this string to the specified object.
boolean	equalsIgnoreCase(String anotherString) Compares this String to another String, ignoring case considerations.
static String	format(Locale l, String format, Object... args) Returns a formatted string using the specified locale, format string, and arguments.
static String	format(String format, Object... args) Returns a formatted string using the specified format string and arguments.
byte[]	getBytes(String charsetName) Encodes this String into a sequence of bytes using the named charset, storing the result into a new byte array.
byte[]	getBytes() Encodes this String into a sequence of bytes using the platform's default charset, storing the result into a new byte array.
byte[]	getBytes(Charset charset) Encodes this String into a sequence of bytes using the given {@linkplain java.nio.charset.Charset charset}, storing the result into a new byte array.
void	getBytes(int srcBegin, int srcEnd, byte[] dst, int dstBegin) This method is deprecated. This method does not properly convert characters into bytes. As of JDK 1.1, the preferred way to do this is via the getBytes() method, which uses the platform's default charset.
void	getChars(int srcBegin, int srcEnd, char[] dst, int dstBegin) Copies characters from this string into the destination character array.
int	hashCode() Returns a hash code for this string.
int	indexOf(int ch, int fromIndex) Returns the index within this string of the first occurrence of the specified character, starting the search at the specified index.
int	indexOf(String str) Returns the index within this string of the first occurrence of the specified substring.
int	indexOf(int ch) Returns the index within this string of the first occurrence of the specified character.
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.
String	intern() Returns a canonical representation for the string object.
boolean	isEmpty() Returns true if, and only if, length() is 0.
static String	join(CharSequence delimiter, CharSequence... elements) Returns a new String composed of copies of the CharSequence elements joined together with a copy of the specified delimiter.
static String	join(CharSequence delimiter, Iterable<? extends CharSequence> elements) Returns a new String composed of copies of the CharSequence elements joined together with a copy of the specified delimiter.
int	lastIndexOf(int ch) Returns the index within this string of the last occurrence of the specified character.
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.
int	lastIndexOf(String str) Returns the index within this string of the last occurrence of the specified substring.
int	lastIndexOf(int ch, int fromIndex) Returns the index within this string of the last occurrence of the specified character, searching backward starting at the specified index.
int	length() Returns the length of this string.
boolean	matches(String regex) Tells whether or not this string matches the given regular expression.
int	offsetByCodePoints(int index, int codePointOffset) Returns the index within this String that is offset from the given index by codePointOffset code points.
boolean	regionMatches(boolean ignoreCase, int toffset, String other, int ooffset, int len) Tests if two string regions are equal.
boolean	regionMatches(int toffset, String other, int ooffset, int len) Tests if two string regions are equal.
String	replace(CharSequence target, CharSequence replacement) Replaces each substring of this string that matches the literal target sequence with the specified literal replacement sequence.
String	replace(char oldChar, char newChar) Returns a string resulting from replacing all occurrences of oldChar in this string with newChar.
String	replaceAll(String regex, String replacement) Replaces each substring of this string that matches the given regular expression with the given replacement.
String	replaceFirst(String regex, String replacement) Replaces the first substring of this string that matches the given regular expression with the given replacement.
String[]	split(String regex) Splits this string around matches of the given regular expression.
String[]	split(String regex, int limit) Splits this string around matches of the given regular expression.
boolean	startsWith(String prefix) Tests if this string starts with the specified prefix.
boolean	startsWith(String prefix, int toffset) Tests if the substring of this string beginning at the specified index starts with the specified prefix.
CharSequence	subSequence(int beginIndex, int endIndex) Returns a character sequence that is a subsequence of this sequence.
String	substring(int beginIndex, int endIndex) Returns a string that is a substring of this string.
String	substring(int beginIndex) Returns a string that is a substring of this string.
char[]	toCharArray() Converts this string to a new character array.
String	toLowerCase() Converts all of the characters in this String to lower case using the rules of the default locale.
String	toLowerCase(Locale locale) Converts all of the characters in this String to lower case using the rules of the given Locale.
String	toString() This object (which is already a string!) is itself returned.
String	toUpperCase(Locale locale) Converts all of the characters in this String to upper case using the rules of the given Locale.
String	toUpperCase() Converts all of the characters in this String to upper case using the rules of the default locale.
String	trim() Returns a string whose value is this string, with any leading and trailing whitespace removed.
static String	valueOf(boolean b) Returns the string representation of the boolean argument.
static String	valueOf(double d) Returns the string representation of the double argument.
static String	valueOf(char[] data, int offset, int count) Returns the string representation of a specific subarray of the char array argument.
static String	valueOf(float f) Returns the string representation of the float argument.
static String	valueOf(int i) Returns the string representation of the int argument.
static String	valueOf(char c) Returns the string representation of the char argument.
static String	valueOf(long l) Returns the string representation of the long argument.
static String	valueOf(Object obj) Returns the string representation of the Object argument.
static String	valueOf(char[] data) Returns the string representation of the char array argument.

Inherited Method Summary

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

From interface java.lang.Comparable

abstract int

compareTo(String o) Compares this object with the specified object for order.

From interface java.lang.CharSequence

abstract char	charAt(int index) Returns the char value at the specified index.
IntStream	chars() Returns a stream of int zero-extending the char values from this sequence.
IntStream	codePoints() Returns a stream of code point values from this sequence.
abstract int	length() Returns the length of this character sequence.
abstract CharSequence	subSequence(int start, int end) Returns a CharSequence that is a subsequence of this sequence.
abstract String	toString() Returns a string containing the characters in this sequence in the same order as this sequence.

Fields

public static final Comparator<String> CASE_INSENSITIVE_ORDER

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

• Collator.compare(String, String)

Public Constructors

public String ()

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.

public String (byte[] bytes)

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 CharsetDecoder class should be used when more control over the decoding process is required.

Parameters

bytes	The bytes to be decoded into characters

public String (byte[] ascii, int hibyte)

This constructor is deprecated.
This method does not properly convert bytes into characters. As of JDK 1.1, the preferred way to do this is via the String constructors that take a Charset, charset name, or that use the platform's default charset.

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))
 

Parameters

ascii	The bytes to be converted to characters
hibyte	The top 8 bits of each 16-bit Unicode code unit

See Also

• 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[])

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

Parameters

bytes	The bytes to be decoded into characters
offset	The index of the first byte to decode
length	The number of bytes to decode

Throws

IndexOutOfBoundsException	If the offset and the length arguments index characters outside the bounds of the bytes array

public String (byte[] ascii, int hibyte, int offset, int count)

This constructor is deprecated.
This method does not properly convert bytes into characters. As of JDK 1.1, the preferred way to do this is via the String constructors that take a Charset, charset name, or that use the platform's default charset.

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.

Parameters

ascii	The bytes to be converted to characters
hibyte	The top 8 bits of each 16-bit Unicode code unit
offset	The initial offset
count	The length

Throws

IndexOutOfBoundsException	If the offset or count argument is invalid

See Also

• String(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[])

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

Parameters

bytes	The bytes to be decoded into characters
offset	The index of the first byte to decode
length	The number of bytes to decode
charsetName	The name of a supported {@linkplain java.nio.charset.Charset charset}

Throws

UnsupportedEncodingException	If the named charset is not supported
IndexOutOfBoundsException	If the offset and length arguments index characters outside the bounds of the bytes array

public String (byte[] bytes, int offset, int length, Charset charset)

Constructs a new String by decoding the specified subarray of bytes using the specified {@linkplain java.nio.charset.Charset 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.

Parameters

bytes	The bytes to be decoded into characters
offset	The index of the first byte to decode
length	The number of bytes to decode
charset	The {@linkplain java.nio.charset.Charset charset} to be used to decode the bytes

Throws

IndexOutOfBoundsException	If the offset and length arguments index characters outside the bounds of the bytes array

public String (byte[] bytes, Charset charset)

Constructs a new String by decoding the specified array of bytes using the specified {@linkplain java.nio.charset.Charset 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.

Parameters

bytes	The bytes to be decoded into characters
charset	The {@linkplain java.nio.charset.Charset charset} to be used to decode the bytes

public String (byte[] bytes, String charsetName)

Constructs a new String by decoding the specified array of bytes using the specified {@linkplain java.nio.charset.Charset 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.

Parameters

bytes	The bytes to be decoded into characters
charsetName	The name of a supported {@linkplain java.nio.charset.Charset charset}

Throws

UnsupportedEncodingException	If the named charset is not supported

public String (char[] value)

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

public String (char[] value, int offset, int count)

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
offset	The initial offset
count	The length

Throws

IndexOutOfBoundsException	If the offset and count arguments index characters outside the bounds of the value array

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

Parameters

codePoints	Array that is the source of Unicode code points
offset	The initial offset
count	The length

Throws

IllegalArgumentException	If any invalid Unicode code point is found in codePoints
IndexOutOfBoundsException	If the offset and count arguments index characters outside the bounds of the codePoints array

public String (String s)

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

s

public String (StringBuffer buffer)

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

public String (StringBuilder builder)

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

Public Methods

public char charAt (int index)

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.

Returns

• the char value at the specified index of this string. The first char value is at index 0.

Throws

IndexOutOfBoundsException	if the index argument is negative or not less than the length of this string.

public int codePointAt (int index)

Returns the character (Unicode code point) at the specified index. The index refers to 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.

Parameters

index	the index to the char values

Returns

• the code point value of the character at the index

Throws

IndexOutOfBoundsException	if the index argument is negative or not less than the length of this string.

public int codePointBefore (int index)

Returns the character (Unicode code point) before the specified index. The index refers to 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.

Parameters

index	the index following the code point that should be returned

Returns

• the Unicode code point value before the given index.

Throws

IndexOutOfBoundsException	if the index argument is less than 1 or greater than the length of this string.

public int codePointCount (int beginIndex, int endIndex)

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 chars) 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 of the text range.
endIndex	the index after the last char of the text range.

Returns

• the number of Unicode code points in the specified text range

Throws

IndexOutOfBoundsException	if the beginIndex is negative, or endIndex is larger than the length of this String, or beginIndex is larger than endIndex.

public int compareTo (String anotherString)

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

Returns

• the value 0 if the argument string is equal to this string; a value less than 0 if this string is lexicographically less than the string argument; and a value greater than 0 if this string is lexicographically greater than the string argument.

public int compareToIgnoreCase (String str)

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.

Returns

• a negative integer, zero, or a positive integer as the specified String is greater than, equal to, or less than this String, ignoring case considerations.

See Also

• Collator.compare(String, String)

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. 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"
 

Parameters

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

Returns

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

public boolean contains (CharSequence s)

Returns true if and only if this string contains the specified sequence of char values.

Parameters

s	the sequence to search for

Returns

• true if this string contains s, false otherwise

public boolean contentEquals (StringBuffer sb)

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. This method synchronizes on the StringBuffer.

Parameters

sb	The StringBuffer to compare this String against

Returns

• true if this String represents the same sequence of characters as the specified StringBuffer, false otherwise

public boolean contentEquals (CharSequence cs)

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. Note that if the CharSequence is a StringBuffer then the method synchronizes on it.

Parameters

cs	The sequence to compare this String against

Returns

• true if this String represents the same sequence of char values as the specified sequence, false otherwise

public static String copyValueOf (char[] data, int offset, int count)

Equivalent to valueOf(char[], int, int).

Parameters

data	the character array.
offset	initial offset of the subarray.
count	length of the subarray.

Returns

• a String that contains the characters of the specified subarray of the character array.

Throws

IndexOutOfBoundsException	if offset is negative, or count is negative, or offset+count is larger than data.length.

public static String copyValueOf (char[] data)

Equivalent to valueOf(char[]).

Parameters

data	the character array.

Returns

• a String that contains the characters of the character array.

public boolean endsWith (String suffix)

Tests if this string ends with the specified suffix.

Parameters

suffix	the suffix.

Returns

• true if the character sequence represented by the argument is a suffix of the character sequence represented by this object; false otherwise. Note that the result will be true if the argument is the empty string or is equal to this String object as determined by the equals(Object) method.

public boolean equals (Object anObject)

Compares this string to the specified object. The result is true if and only if the argument is not null and is a String object that represents the same sequence of characters as this object.

Parameters

anObject	The object to compare this String against

Returns

• true if the given object represents a String equivalent to this string, false otherwise

See Also

• compareTo(String)
• equalsIgnoreCase(String)

public boolean equalsIgnoreCase (String anotherString)

Compares this String to another String, ignoring case considerations. Two strings are considered equal ignoring case if they are of the same length and corresponding characters in the two strings are equal ignoring case.

Two characters c1 and c2 are considered the same ignoring case if at least one of the following is true:

• The two characters are the same (as compared by the == operator)
• Applying the method Character.toUpperCase(char) to each character produces the same result
• Applying the method Character.toLowerCase(char) to each character produces the same result

Parameters

anotherString	The String to compare this String against

Returns

• true if the argument is not null and it represents an equivalent String ignoring case; false otherwise

See Also

• equals(Object)

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 {@linkplain java.util.Locale locale} to apply during formatting. If l is null then no localization is applied.
format	A format string
args	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.

Returns

• A formatted string

Throws

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

See Also

• Formatter

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 Locale.getDefault().

Parameters

format

A format string

args

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.

Returns

• A formatted string

Throws

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.

See Also

• Formatter