Google Git
Sign in
android / platform / tools / idea / 9b5d02ac8c92b1e71523cc15cb3d168d57fbd898 / . / java / java-tests / testData / codeInsight / externalJavadoc / String / 7 / page.html
blob: cb9eb1ff04299752193a8e1b25c3f0a4a1643d69 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.6.0_14) on Wed Jul 13 05:19:32 PDT 2011 -->
<title>String (Java Platform SE 7 )</title>
<meta name="date" content="2011-07-13">
<meta name="keywords" content="java.lang.String class">
<meta name="keywords" content="CASE_INSENSITIVE_ORDER">
<meta name="keywords" content="length()">
<meta name="keywords" content="isEmpty()">
<meta name="keywords" content="charAt()">
<meta name="keywords" content="codePointAt()">
<meta name="keywords" content="codePointBefore()">
<meta name="keywords" content="codePointCount()">
<meta name="keywords" content="offsetByCodePoints()">
<meta name="keywords" content="getChars()">
<meta name="keywords" content="getBytes()">
<meta name="keywords" content="equals()">
<meta name="keywords" content="contentEquals()">
<meta name="keywords" content="equalsIgnoreCase()">
<meta name="keywords" content="compareTo()">
<meta name="keywords" content="compareToIgnoreCase()">
<meta name="keywords" content="regionMatches()">
<meta name="keywords" content="startsWith()">
<meta name="keywords" content="endsWith()">
<meta name="keywords" content="hashCode()">
<meta name="keywords" content="indexOf()">
<meta name="keywords" content="lastIndexOf()">
<meta name="keywords" content="substring()">
<meta name="keywords" content="subSequence()">
<meta name="keywords" content="concat()">
<meta name="keywords" content="replace()">
<meta name="keywords" content="matches()">
<meta name="keywords" content="contains()">
<meta name="keywords" content="replaceFirst()">
<meta name="keywords" content="replaceAll()">
<meta name="keywords" content="split()">
<meta name="keywords" content="toLowerCase()">
<meta name="keywords" content="toUpperCase()">
<meta name="keywords" content="trim()">
<meta name="keywords" content="toString()">
<meta name="keywords" content="toCharArray()">
<meta name="keywords" content="format()">
<meta name="keywords" content="valueOf()">
<meta name="keywords" content="copyValueOf()">
<meta name="keywords" content="intern()">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="String (Java Platform SE 7 )";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/String.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><strong>Java&trade;&nbsp;Platform<br>Standard&nbsp;Ed.&nbsp;7</strong></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../java/lang/StrictMath.html" title="class in java.lang"><span class="strong">Prev Class</span></a></li>
<li><a href="../../java/lang/StringBuffer.html" title="class in java.lang"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?java/lang/String.html" target="_top">Frames</a></li>
<li><a href="String.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">java.lang</div>
<h2 title="Class String" class="title">Class String</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="../../java/lang/Object.html" title="class in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>java.lang.String</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../java/io/Serializable.html" title="interface in java.io">Serializable</a>, <a href="../../java/lang/CharSequence.html" title="interface in java.lang">CharSequence</a>, <a href="../../java/lang/Comparable.html" title="interface in java.lang">Comparable</a>&lt;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&gt;</dd>
</dl>
<hr>
<br>
<pre>public final class <span class="strong">String</span>
extends <a href="../../java/lang/Object.html" title="class in java.lang">Object</a>
implements <a href="../../java/io/Serializable.html" title="interface in java.io">Serializable</a>, <a href="../../java/lang/Comparable.html" title="interface in java.lang">Comparable</a>&lt;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&gt;, <a href="../../java/lang/CharSequence.html" title="interface in java.lang">CharSequence</a></pre>
<div class="block">The <code>String</code> class represents character strings. All
string literals in Java programs, such as <code>"abc"</code>, are
implemented as instances of this class.
<p>
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:
<p><blockquote><pre>
String str = "abc";
</pre></blockquote><p>
is equivalent to:
<p><blockquote><pre>
char data[] = {'a', 'b', 'c'};
String str = new String(data);
</pre></blockquote><p>
Here are some more examples of how strings can be used:
<p><blockquote><pre>
System.out.println("abc");
String cde = "cde";
System.out.println("abc" + cde);
String c = "abc".substring(2,3);
String d = cde.substring(1, 2);
</pre></blockquote>
<p>
The class <code>String</code> 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 <a href="../../java/lang/Character.html" title="class in java.lang"><code>Character</code></a> class.
<p>
The Java language provides special support for the string
concatenation operator (&nbsp;+&nbsp;), and for conversion of
other objects to strings. String concatenation is implemented
through the <code>StringBuilder</code>(or <code>StringBuffer</code>)
class and its <code>append</code> method.
String conversions are implemented through the method
<code>toString</code>, defined by <code>Object</code> and
inherited by all classes in Java. For additional information on
string concatenation and conversion, see Gosling, Joy, and Steele,
<i>The Java Language Specification</i>.
<p> Unless otherwise noted, passing a <tt>null</tt> argument to a constructor
or method in this class will cause a <a href="../../java/lang/NullPointerException.html" title="class in java.lang"><code>NullPointerException</code></a> to be
thrown.
<p>A <code>String</code> represents a string in the UTF-16 format
in which <em>supplementary characters</em> are represented by <em>surrogate
pairs</em> (see the section <a href="Character.html#unicode">Unicode
Character Representations</a> in the <code>Character</code> class for
more information).
Index values refer to <code>char</code> code units, so a supplementary
character uses two positions in a <code>String</code>.
<p>The <code>String</code> class provides methods for dealing with
Unicode code points (i.e., characters), in addition to those for
dealing with Unicode code units (i.e., <code>char</code> values).</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>JDK1.0</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../java/lang/Object.html#toString()"><code>Object.toString()</code></a>,
<a href="../../java/lang/StringBuffer.html" title="class in java.lang"><code>StringBuffer</code></a>,
<a href="../../java/lang/StringBuilder.html" title="class in java.lang"><code>StringBuilder</code></a>,
<a href="../../java/nio/charset/Charset.html" title="class in java.nio.charset"><code>Charset</code></a>,
<a href="../../serialized-form.html#java.lang.String">Serialized Form</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../java/util/Comparator.html" title="interface in java.util">Comparator</a>&lt;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#CASE_INSENSITIVE_ORDER">CASE_INSENSITIVE_ORDER</a></strong></code>
<div class="block">A Comparator that orders <code>String</code> objects as by
<code>compareToIgnoreCase</code>.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../java/lang/String.html#String()">String</a></strong>()</code>
<div class="block">Initializes a newly created <code>String</code> object so that it represents
an empty character sequence.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../java/lang/String.html#String(byte[])">String</a></strong>(byte[]&nbsp;bytes)</code>
<div class="block">Constructs a new <code>String</code> by decoding the specified array of bytes
using the platform's default charset.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../java/lang/String.html#String(byte[], java.nio.charset.Charset)">String</a></strong>(byte[]&nbsp;bytes,
<a href="../../java/nio/charset/Charset.html" title="class in java.nio.charset">Charset</a>&nbsp;charset)</code>
<div class="block">Constructs a new <code>String</code> by decoding the specified array of
bytes using the specified <a href="../../java/nio/charset/Charset.html" title="class in java.nio.charset">charset</a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../java/lang/String.html#String(byte[], int)">String</a></strong>(byte[]&nbsp;ascii,
int&nbsp;hibyte)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>This method does not properly convert bytes into
characters. As of JDK&nbsp;1.1, the preferred way to do this is via the
<code>String</code> constructors that take a <a href="../../java/nio/charset/Charset.html" title="class in java.nio.charset"><code>Charset</code></a>, charset name, or that use the platform's
default charset.</i></div>
</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../java/lang/String.html#String(byte[], int, int)">String</a></strong>(byte[]&nbsp;bytes,
int&nbsp;offset,
int&nbsp;length)</code>
<div class="block">Constructs a new <code>String</code> by decoding the specified subarray of
bytes using the platform's default charset.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../java/lang/String.html#String(byte[], int, int, java.nio.charset.Charset)">String</a></strong>(byte[]&nbsp;bytes,
int&nbsp;offset,
int&nbsp;length,
<a href="../../java/nio/charset/Charset.html" title="class in java.nio.charset">Charset</a>&nbsp;charset)</code>
<div class="block">Constructs a new <code>String</code> by decoding the specified subarray of
bytes using the specified <a href="../../java/nio/charset/Charset.html" title="class in java.nio.charset">charset</a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../java/lang/String.html#String(byte[], int, int, int)">String</a></strong>(byte[]&nbsp;ascii,
int&nbsp;hibyte,
int&nbsp;offset,
int&nbsp;count)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>This method does not properly convert bytes into characters.
As of JDK&nbsp;1.1, the preferred way to do this is via the
<code>String</code> constructors that take a <a href="../../java/nio/charset/Charset.html" title="class in java.nio.charset"><code>Charset</code></a>, charset name, or that use the platform's
default charset.</i></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../java/lang/String.html#String(byte[], int, int, java.lang.String)">String</a></strong>(byte[]&nbsp;bytes,
int&nbsp;offset,
int&nbsp;length,
<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;charsetName)</code>
<div class="block">Constructs a new <code>String</code> by decoding the specified subarray of
bytes using the specified charset.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../java/lang/String.html#String(byte[], java.lang.String)">String</a></strong>(byte[]&nbsp;bytes,
<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;charsetName)</code>
<div class="block">Constructs a new <code>String</code> by decoding the specified array of bytes
using the specified <a href="../../java/nio/charset/Charset.html" title="class in java.nio.charset">charset</a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../java/lang/String.html#String(char[])">String</a></strong>(char[]&nbsp;value)</code>
<div class="block">Allocates a new <code>String</code> so that it represents the sequence of
characters currently contained in the character array argument.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../java/lang/String.html#String(char[], int, int)">String</a></strong>(char[]&nbsp;value,
int&nbsp;offset,
int&nbsp;count)</code>
<div class="block">Allocates a new <code>String</code> that contains characters from a subarray
of the character array argument.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../java/lang/String.html#String(int[], int, int)">String</a></strong>(int[]&nbsp;codePoints,
int&nbsp;offset,
int&nbsp;count)</code>
<div class="block">Allocates a new <code>String</code> that contains characters from a subarray
of the <a href="Character.html#unicode">Unicode code point</a> array
argument.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../java/lang/String.html#String(java.lang.String)">String</a></strong>(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;original)</code>
<div class="block">Initializes a newly created <code>String</code> 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.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../java/lang/String.html#String(java.lang.StringBuffer)">String</a></strong>(<a href="../../java/lang/StringBuffer.html" title="class in java.lang">StringBuffer</a>&nbsp;buffer)</code>
<div class="block">Allocates a new string that contains the sequence of characters
currently contained in the string buffer argument.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../java/lang/String.html#String(java.lang.StringBuilder)">String</a></strong>(<a href="../../java/lang/StringBuilder.html" title="class in java.lang">StringBuilder</a>&nbsp;builder)</code>
<div class="block">Allocates a new string that contains the sequence of characters
currently contained in the string builder argument.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>char</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#charAt(int)">charAt</a></strong>(int&nbsp;index)</code>
<div class="block">Returns the <code>char</code> value at the
specified index.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#codePointAt(int)">codePointAt</a></strong>(int&nbsp;index)</code>
<div class="block">Returns the character (Unicode code point) at the specified
index.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#codePointBefore(int)">codePointBefore</a></strong>(int&nbsp;index)</code>
<div class="block">Returns the character (Unicode code point) before the specified
index.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#codePointCount(int, int)">codePointCount</a></strong>(int&nbsp;beginIndex,
int&nbsp;endIndex)</code>
<div class="block">Returns the number of Unicode code points in the specified text
range of this <code>String</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#compareTo(java.lang.String)">compareTo</a></strong>(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;anotherString)</code>
<div class="block">Compares two strings lexicographically.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#compareToIgnoreCase(java.lang.String)">compareToIgnoreCase</a></strong>(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;str)</code>
<div class="block">Compares two strings lexicographically, ignoring case
differences.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#concat(java.lang.String)">concat</a></strong>(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;str)</code>
<div class="block">Concatenates the specified string to the end of this string.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#contains(java.lang.CharSequence)">contains</a></strong>(<a href="../../java/lang/CharSequence.html" title="interface in java.lang">CharSequence</a>&nbsp;s)</code>
<div class="block">Returns true if and only if this string contains the specified
sequence of char values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#contentEquals(java.lang.CharSequence)">contentEquals</a></strong>(<a href="../../java/lang/CharSequence.html" title="interface in java.lang">CharSequence</a>&nbsp;cs)</code>
<div class="block">Compares this string to the specified <code>CharSequence</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#contentEquals(java.lang.StringBuffer)">contentEquals</a></strong>(<a href="../../java/lang/StringBuffer.html" title="class in java.lang">StringBuffer</a>&nbsp;sb)</code>
<div class="block">Compares this string to the specified <code>StringBuffer</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#copyValueOf(char[])">copyValueOf</a></strong>(char[]&nbsp;data)</code>
<div class="block">Returns a String that represents the character sequence in the
array specified.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#copyValueOf(char[], int, int)">copyValueOf</a></strong>(char[]&nbsp;data,
int&nbsp;offset,
int&nbsp;count)</code>
<div class="block">Returns a String that represents the character sequence in the
array specified.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#endsWith(java.lang.String)">endsWith</a></strong>(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;suffix)</code>
<div class="block">Tests if this string ends with the specified suffix.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#equals(java.lang.Object)">equals</a></strong>(<a href="../../java/lang/Object.html" title="class in java.lang">Object</a>&nbsp;anObject)</code>
<div class="block">Compares this string to the specified object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#equalsIgnoreCase(java.lang.String)">equalsIgnoreCase</a></strong>(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;anotherString)</code>
<div class="block">Compares this <code>String</code> to another <code>String</code>, ignoring case
considerations.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#format(java.util.Locale, java.lang.String, java.lang.Object...)">format</a></strong>(<a href="../../java/util/Locale.html" title="class in java.util">Locale</a>&nbsp;l,
<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;format,
<a href="../../java/lang/Object.html" title="class in java.lang">Object</a>...&nbsp;args)</code>
<div class="block">Returns a formatted string using the specified locale, format string,
and arguments.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#format(java.lang.String, java.lang.Object...)">format</a></strong>(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;format,
<a href="../../java/lang/Object.html" title="class in java.lang">Object</a>...&nbsp;args)</code>
<div class="block">Returns a formatted string using the specified format string and
arguments.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#getBytes()">getBytes</a></strong>()</code>
<div class="block">Encodes this <code>String</code> into a sequence of bytes using the
platform's default charset, storing the result into a new byte array.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#getBytes(java.nio.charset.Charset)">getBytes</a></strong>(<a href="../../java/nio/charset/Charset.html" title="class in java.nio.charset">Charset</a>&nbsp;charset)</code>
<div class="block">Encodes this <code>String</code> into a sequence of bytes using the given
<a href="../../java/nio/charset/Charset.html" title="class in java.nio.charset">charset</a>, storing the result into a
new byte array.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#getBytes(int, int, byte[], int)">getBytes</a></strong>(int&nbsp;srcBegin,
int&nbsp;srcEnd,
byte[]&nbsp;dst,
int&nbsp;dstBegin)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>This method does not properly convert characters into
bytes. As of JDK&nbsp;1.1, the preferred way to do this is via the
<a href="../../java/lang/String.html#getBytes()"><code>getBytes()</code></a> method, which uses the platform's default charset.</i></div>
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#getBytes(java.lang.String)">getBytes</a></strong>(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;charsetName)</code>
<div class="block">Encodes this <code>String</code> into a sequence of bytes using the named
charset, storing the result into a new byte array.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#getChars(int, int, char[], int)">getChars</a></strong>(int&nbsp;srcBegin,
int&nbsp;srcEnd,
char[]&nbsp;dst,
int&nbsp;dstBegin)</code>
<div class="block">Copies characters from this string into the destination character
array.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#hashCode()">hashCode</a></strong>()</code>
<div class="block">Returns a hash code for this string.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#indexOf(int)">indexOf</a></strong>(int&nbsp;ch)</code>
<div class="block">Returns the index within this string of the first occurrence of
the specified character.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#indexOf(int, int)">indexOf</a></strong>(int&nbsp;ch,
int&nbsp;fromIndex)</code>
<div class="block">Returns the index within this string of the first occurrence of the
specified character, starting the search at the specified index.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#indexOf(java.lang.String)">indexOf</a></strong>(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;str)</code>
<div class="block">Returns the index within this string of the first occurrence of the
specified substring.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#indexOf(java.lang.String, int)">indexOf</a></strong>(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;str,
int&nbsp;fromIndex)</code>
<div class="block">Returns the index within this string of the first occurrence of the
specified substring, starting at the specified index.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#intern()">intern</a></strong>()</code>
<div class="block">Returns a canonical representation for the string object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#isEmpty()">isEmpty</a></strong>()</code>
<div class="block">Returns <tt>true</tt> if, and only if, <a href="../../java/lang/String.html#length()"><code>length()</code></a> is <tt>0</tt>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#lastIndexOf(int)">lastIndexOf</a></strong>(int&nbsp;ch)</code>
<div class="block">Returns the index within this string of the last occurrence of
the specified character.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#lastIndexOf(int, int)">lastIndexOf</a></strong>(int&nbsp;ch,
int&nbsp;fromIndex)</code>
<div class="block">Returns the index within this string of the last occurrence of
the specified character, searching backward starting at the
specified index.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#lastIndexOf(java.lang.String)">lastIndexOf</a></strong>(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;str)</code>
<div class="block">Returns the index within this string of the last occurrence of the
specified substring.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#lastIndexOf(java.lang.String, int)">lastIndexOf</a></strong>(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;str,
int&nbsp;fromIndex)</code>
<div class="block">Returns the index within this string of the last occurrence of the
specified substring, searching backward starting at the specified index.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#length()">length</a></strong>()</code>
<div class="block">Returns the length of this string.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#matches(java.lang.String)">matches</a></strong>(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;regex)</code>
<div class="block">Tells whether or not this string matches the given <a
href="../util/regex/Pattern.html#sum">regular expression</a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#offsetByCodePoints(int, int)">offsetByCodePoints</a></strong>(int&nbsp;index,
int&nbsp;codePointOffset)</code>
<div class="block">Returns the index within this <code>String</code> that is
offset from the given <code>index</code> by
<code>codePointOffset</code> code points.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#regionMatches(boolean, int, java.lang.String, int, int)">regionMatches</a></strong>(boolean&nbsp;ignoreCase,
int&nbsp;toffset,
<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;other,
int&nbsp;ooffset,
int&nbsp;len)</code>
<div class="block">Tests if two string regions are equal.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#regionMatches(int, java.lang.String, int, int)">regionMatches</a></strong>(int&nbsp;toffset,
<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;other,
int&nbsp;ooffset,
int&nbsp;len)</code>
<div class="block">Tests if two string regions are equal.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#replace(char, char)">replace</a></strong>(char&nbsp;oldChar,
char&nbsp;newChar)</code>
<div class="block">Returns a new string resulting from replacing all occurrences of
<code>oldChar</code> in this string with <code>newChar</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#replace(java.lang.CharSequence, java.lang.CharSequence)">replace</a></strong>(<a href="../../java/lang/CharSequence.html" title="interface in java.lang">CharSequence</a>&nbsp;target,
<a href="../../java/lang/CharSequence.html" title="interface in java.lang">CharSequence</a>&nbsp;replacement)</code>
<div class="block">Replaces each substring of this string that matches the literal target
sequence with the specified literal replacement sequence.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#replaceAll(java.lang.String, java.lang.String)">replaceAll</a></strong>(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;regex,
<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;replacement)</code>
<div class="block">Replaces each substring of this string that matches the given <a
href="../util/regex/Pattern.html#sum">regular expression</a> with the
given replacement.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#replaceFirst(java.lang.String, java.lang.String)">replaceFirst</a></strong>(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;regex,
<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;replacement)</code>
<div class="block">Replaces the first substring of this string that matches the given <a
href="../util/regex/Pattern.html#sum">regular expression</a> with the
given replacement.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../java/lang/String.html" title="class in java.lang">String</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#split(java.lang.String)">split</a></strong>(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;regex)</code>
<div class="block">Splits this string around matches of the given <a
href="../util/regex/Pattern.html#sum">regular expression</a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../java/lang/String.html" title="class in java.lang">String</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#split(java.lang.String, int)">split</a></strong>(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;regex,
int&nbsp;limit)</code>
<div class="block">Splits this string around matches of the given
<a href="../util/regex/Pattern.html#sum">regular expression</a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#startsWith(java.lang.String)">startsWith</a></strong>(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;prefix)</code>
<div class="block">Tests if this string starts with the specified prefix.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#startsWith(java.lang.String, int)">startsWith</a></strong>(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;prefix,
int&nbsp;toffset)</code>
<div class="block">Tests if the substring of this string beginning at the
specified index starts with the specified prefix.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../java/lang/CharSequence.html" title="interface in java.lang">CharSequence</a></code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#subSequence(int, int)">subSequence</a></strong>(int&nbsp;beginIndex,
int&nbsp;endIndex)</code>
<div class="block">Returns a new character sequence that is a subsequence of this sequence.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#substring(int)">substring</a></strong>(int&nbsp;beginIndex)</code>
<div class="block">Returns a new string that is a substring of this string.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#substring(int, int)">substring</a></strong>(int&nbsp;beginIndex,
int&nbsp;endIndex)</code>
<div class="block">Returns a new string that is a substring of this string.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>char[]</code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#toCharArray()">toCharArray</a></strong>()</code>
<div class="block">Converts this string to a new character array.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#toLowerCase()">toLowerCase</a></strong>()</code>
<div class="block">Converts all of the characters in this <code>String</code> to lower
case using the rules of the default locale.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#toLowerCase(java.util.Locale)">toLowerCase</a></strong>(<a href="../../java/util/Locale.html" title="class in java.util">Locale</a>&nbsp;locale)</code>
<div class="block">Converts all of the characters in this <code>String</code> to lower
case using the rules of the given <code>Locale</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#toString()">toString</a></strong>()</code>
<div class="block">This object (which is already a string!) is itself returned.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#toUpperCase()">toUpperCase</a></strong>()</code>
<div class="block">Converts all of the characters in this <code>String</code> to upper
case using the rules of the default locale.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#toUpperCase(java.util.Locale)">toUpperCase</a></strong>(<a href="../../java/util/Locale.html" title="class in java.util">Locale</a>&nbsp;locale)</code>
<div class="block">Converts all of the characters in this <code>String</code> to upper
case using the rules of the given <code>Locale</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#trim()">trim</a></strong>()</code>
<div class="block">Returns a copy of the string, with leading and trailing whitespace
omitted.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#valueOf(boolean)">valueOf</a></strong>(boolean&nbsp;b)</code>
<div class="block">Returns the string representation of the <code>boolean</code> argument.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#valueOf(char)">valueOf</a></strong>(char&nbsp;c)</code>
<div class="block">Returns the string representation of the <code>char</code>
argument.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#valueOf(char[])">valueOf</a></strong>(char[]&nbsp;data)</code>
<div class="block">Returns the string representation of the <code>char</code> array
argument.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#valueOf(char[], int, int)">valueOf</a></strong>(char[]&nbsp;data,
int&nbsp;offset,
int&nbsp;count)</code>
<div class="block">Returns the string representation of a specific subarray of the
<code>char</code> array argument.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#valueOf(double)">valueOf</a></strong>(double&nbsp;d)</code>
<div class="block">Returns the string representation of the <code>double</code> argument.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#valueOf(float)">valueOf</a></strong>(float&nbsp;f)</code>
<div class="block">Returns the string representation of the <code>float</code> argument.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#valueOf(int)">valueOf</a></strong>(int&nbsp;i)</code>
<div class="block">Returns the string representation of the <code>int</code> argument.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#valueOf(long)">valueOf</a></strong>(long&nbsp;l)</code>
<div class="block">Returns the string representation of the <code>long</code> argument.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../java/lang/String.html#valueOf(java.lang.Object)">valueOf</a></strong>(<a href="../../java/lang/Object.html" title="class in java.lang">Object</a>&nbsp;obj)</code>
<div class="block">Returns the string representation of the <code>Object</code> argument.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="../../java/lang/Object.html" title="class in java.lang">Object</a></h3>
<code><a href="../../java/lang/Object.html#clone()">clone</a>, <a href="../../java/lang/Object.html#finalize()">finalize</a>, <a href="../../java/lang/Object.html#getClass()">getClass</a>, <a href="../../java/lang/Object.html#notify()">notify</a>, <a href="../../java/lang/Object.html#notifyAll()">notifyAll</a>, <a href="../../java/lang/Object.html#wait()">wait</a>, <a href="../../java/lang/Object.html#wait(long)">wait</a>, <a href="../../java/lang/Object.html#wait(long, int)">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="CASE_INSENSITIVE_ORDER">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CASE_INSENSITIVE_ORDER</h4>
<pre>public static final&nbsp;<a href="../../java/util/Comparator.html" title="interface in java.util">Comparator</a>&lt;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&gt; CASE_INSENSITIVE_ORDER</pre>
<div class="block">A Comparator that orders <code>String</code> objects as by
<code>compareToIgnoreCase</code>. This comparator is serializable.
<p>
Note that this Comparator does <em>not</em> take locale into account,
and will result in an unsatisfactory ordering for certain locales.
The java.text package provides <em>Collators</em> to allow
locale-sensitive ordering.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.2</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../java/text/Collator.html#compare(java.lang.String, java.lang.String)"><code>Collator.compare(String, String)</code></a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="String()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>String</h4>
<pre>public&nbsp;String()</pre>
<div class="block">Initializes a newly created <code>String</code> object so that it represents
an empty character sequence. Note that use of this constructor is
unnecessary since Strings are immutable.</div>
</li>
</ul>
<a name="String(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>String</h4>
<pre>public&nbsp;String(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;original)</pre>
<div class="block">Initializes a newly created <code>String</code> 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 <code>original</code> is needed, use of this constructor is
unnecessary since Strings are immutable.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>original</code> - A <code>String</code></dd></dl>
</li>
</ul>
<a name="String(char[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>String</h4>
<pre>public&nbsp;String(char[]&nbsp;value)</pre>
<div class="block">Allocates a new <code>String</code> 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.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - The initial value of the string</dd></dl>
</li>
</ul>
<a name="String(char[], int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>String</h4>
<pre>public&nbsp;String(char[]&nbsp;value,
int&nbsp;offset,
int&nbsp;count)</pre>
<div class="block">Allocates a new <code>String</code> that contains characters from a subarray
of the character array argument. The <code>offset</code> argument is the
index of the first character of the subarray and the <code>count</code>
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.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - Array that is the source of characters</dd><dd><code>offset</code> - The initial offset</dd><dd><code>count</code> - The length</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../java/lang/IndexOutOfBoundsException.html" title="class in java.lang">IndexOutOfBoundsException</a></code> - If the <code>offset</code> and <code>count</code> arguments index
characters outside the bounds of the <code>value</code> array</dd></dl>
</li>
</ul>
<a name="String(int[], int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>String</h4>
<pre>public&nbsp;String(int[]&nbsp;codePoints,
int&nbsp;offset,
int&nbsp;count)</pre>
<div class="block">Allocates a new <code>String</code> that contains characters from a subarray
of the <a href="Character.html#unicode">Unicode code point</a> array
argument. The <code>offset</code> argument is the index of the first code
point of the subarray and the <code>count</code> argument specifies the
length of the subarray. The contents of the subarray are converted to
<code>char</code>s; subsequent modification of the <code>int</code> array does not
affect the newly created string.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>codePoints</code> - Array that is the source of Unicode code points</dd><dd><code>offset</code> - The initial offset</dd><dd><code>count</code> - The length</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../java/lang/IllegalArgumentException.html" title="class in java.lang">IllegalArgumentException</a></code> - If any invalid Unicode code point is found in <code>codePoints</code></dd>
<dd><code><a href="../../java/lang/IndexOutOfBoundsException.html" title="class in java.lang">IndexOutOfBoundsException</a></code> - If the <code>offset</code> and <code>count</code> arguments index
characters outside the bounds of the <code>codePoints</code> array</dd><dt><span class="strong">Since:</span></dt>
<dd>1.5</dd></dl>
</li>
</ul>
<a name="String(byte[], int, int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>String</h4>
<pre><a href="../../java/lang/Deprecated.html" title="annotation in java.lang">@Deprecated</a>
public&nbsp;String(byte[]&nbsp;ascii,
int&nbsp;hibyte,
int&nbsp;offset,
int&nbsp;count)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>This method does not properly convert bytes into characters.
As of JDK&nbsp;1.1, the preferred way to do this is via the
<code>String</code> constructors that take a <a href="../../java/nio/charset/Charset.html" title="class in java.nio.charset"><code>Charset</code></a>, charset name, or that use the platform's
default charset.</i></div>
<div class="block">Allocates a new <code>String</code> constructed from a subarray of an array
of 8-bit integer values.
<p> The <code>offset</code> argument is the index of the first byte of the
subarray, and the <code>count</code> argument specifies the length of the
subarray.
<p> Each <code>byte</code> in the subarray is converted to a <code>char</code> as
specified in the method above.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ascii</code> - The bytes to be converted to characters</dd><dd><code>hibyte</code> - The top 8 bits of each 16-bit Unicode code unit</dd><dd><code>offset</code> - The initial offset</dd><dd><code>count</code> - The length</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../java/lang/IndexOutOfBoundsException.html" title="class in java.lang">IndexOutOfBoundsException</a></code> - If the <code>offset</code> or <code>count</code> argument is invalid</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../java/lang/String.html#String(byte[], int)"><code>String(byte[], int)</code></a>,
<a href="../../java/lang/String.html#String(byte[], int, int, java.lang.String)"><code>String(byte[], int, int, java.lang.String)</code></a>,
<a href="../../java/lang/String.html#String(byte[], int, int, java.nio.charset.Charset)"><code>String(byte[], int, int, java.nio.charset.Charset)</code></a>,
<a href="../../java/lang/String.html#String(byte[], int, int)"><code>String(byte[], int, int)</code></a>,
<a href="../../java/lang/String.html#String(byte[], java.lang.String)"><code>String(byte[], java.lang.String)</code></a>,
<a href="../../java/lang/String.html#String(byte[], java.nio.charset.Charset)"><code>String(byte[], java.nio.charset.Charset)</code></a>,
<a href="../../java/lang/String.html#String(byte[])"><code>String(byte[])</code></a></dd></dl>
</li>
</ul>
<a name="String(byte[], int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>String</h4>
<pre><a href="../../java/lang/Deprecated.html" title="annotation in java.lang">@Deprecated</a>
public&nbsp;String(byte[]&nbsp;ascii,
int&nbsp;hibyte)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>This method does not properly convert bytes into
characters. As of JDK&nbsp;1.1, the preferred way to do this is via the
<code>String</code> constructors that take a <a href="../../java/nio/charset/Charset.html" title="class in java.nio.charset"><code>Charset</code></a>, charset name, or that use the platform's
default charset.</i></div>
<div class="block">Allocates a new <code>String</code> containing characters constructed from
an array of 8-bit integer values. Each character <i>c</i>in the
resulting string is constructed from the corresponding component
<i>b</i> in the byte array such that:
<blockquote><pre>
<b><i>c</i></b> == (char)(((hibyte &amp; 0xff) &lt;&lt; 8)
| (<b><i>b</i></b> &amp; 0xff))
</pre></blockquote></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ascii</code> - The bytes to be converted to characters</dd><dd><code>hibyte</code> - The top 8 bits of each 16-bit Unicode code unit</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../java/lang/String.html#String(byte[], int, int, java.lang.String)"><code>String(byte[], int, int, java.lang.String)</code></a>,
<a href="../../java/lang/String.html#String(byte[], int, int, java.nio.charset.Charset)"><code>String(byte[], int, int, java.nio.charset.Charset)</code></a>,
<a href="../../java/lang/String.html#String(byte[], int, int)"><code>String(byte[], int, int)</code></a>,
<a href="../../java/lang/String.html#String(byte[], java.lang.String)"><code>String(byte[], java.lang.String)</code></a>,
<a href="../../java/lang/String.html#String(byte[], java.nio.charset.Charset)"><code>String(byte[], java.nio.charset.Charset)</code></a>,
<a href="../../java/lang/String.html#String(byte[])"><code>String(byte[])</code></a></dd></dl>
</li>
</ul>
<a name="String(byte[], int, int, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>String</h4>
<pre>public&nbsp;String(byte[]&nbsp;bytes,
int&nbsp;offset,
int&nbsp;length,
<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;charsetName)
throws <a href="../../java/io/UnsupportedEncodingException.html" title="class in java.io">UnsupportedEncodingException</a></pre>
<div class="block">Constructs a new <code>String</code> by decoding the specified subarray of
bytes using the specified charset. The length of the new <code>String</code>
is a function of the charset, and hence may not be equal to the length
of the subarray.
<p> The behavior of this constructor when the given bytes are not valid
in the given charset is unspecified. The <a href="../../java/nio/charset/CharsetDecoder.html" title="class in java.nio.charset"><code>CharsetDecoder</code></a> class should be used when more control
over the decoding process is required.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>bytes</code> - The bytes to be decoded into characters</dd><dd><code>offset</code> - The index of the first byte to decode</dd><dd><code>length</code> - The number of bytes to decode</dd><dd><code>charsetName</code> - The name of a supported <a href="../../java/nio/charset/Charset.html" title="class in java.nio.charset">charset</a></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../java/io/UnsupportedEncodingException.html" title="class in java.io">UnsupportedEncodingException</a></code> - If the named charset is not supported</dd>
<dd><code><a href="../../java/lang/IndexOutOfBoundsException.html" title="class in java.lang">IndexOutOfBoundsException</a></code> - If the <code>offset</code> and <code>length</code> arguments index
characters outside the bounds of the <code>bytes</code> array</dd><dt><span class="strong">Since:</span></dt>
<dd>JDK1.1</dd></dl>
</li>
</ul>
<a name="String(byte[], int, int, java.nio.charset.Charset)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>String</h4>
<pre>public&nbsp;String(byte[]&nbsp;bytes,
int&nbsp;offset,
int&nbsp;length,
<a href="../../java/nio/charset/Charset.html" title="class in java.nio.charset">Charset</a>&nbsp;charset)</pre>
<div class="block">Constructs a new <code>String</code> by decoding the specified subarray of
bytes using the specified <a href="../../java/nio/charset/Charset.html" title="class in java.nio.charset">charset</a>.
The length of the new <code>String</code> is a function of the charset, and
hence may not be equal to the length of the subarray.
<p> This method always replaces malformed-input and unmappable-character
sequences with this charset's default replacement string. The <a href="../../java/nio/charset/CharsetDecoder.html" title="class in java.nio.charset"><code>CharsetDecoder</code></a> class should be used when more control
over the decoding process is required.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>bytes</code> - The bytes to be decoded into characters</dd><dd><code>offset</code> - The index of the first byte to decode</dd><dd><code>length</code> - The number of bytes to decode</dd><dd><code>charset</code> - The <a href="../../java/nio/charset/Charset.html" title="class in java.nio.charset">charset</a> to be used to
decode the <code>bytes</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../java/lang/IndexOutOfBoundsException.html" title="class in java.lang">IndexOutOfBoundsException</a></code> - If the <code>offset</code> and <code>length</code> arguments index
characters outside the bounds of the <code>bytes</code> array</dd><dt><span class="strong">Since:</span></dt>
<dd>1.6</dd></dl>
</li>
</ul>
<a name="String(byte[], java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>String</h4>
<pre>public&nbsp;String(byte[]&nbsp;bytes,
<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;charsetName)
throws <a href="../../java/io/UnsupportedEncodingException.html" title="class in java.io">UnsupportedEncodingException</a></pre>
<div class="block">Constructs a new <code>String</code> by decoding the specified array of bytes
using the specified <a href="../../java/nio/charset/Charset.html" title="class in java.nio.charset">charset</a>. The
length of the new <code>String</code> is a function of the charset, and hence
may not be equal to the length of the byte array.
<p> The behavior of this constructor when the given bytes are not valid
in the given charset is unspecified. The <a href="../../java/nio/charset/CharsetDecoder.html" title="class in java.nio.charset"><code>CharsetDecoder</code></a> class should be used when more control
over the decoding process is required.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>bytes</code> - The bytes to be decoded into characters</dd><dd><code>charsetName</code> - The name of a supported <a href="../../java/nio/charset/Charset.html" title="class in java.nio.charset">charset</a></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../java/io/UnsupportedEncodingException.html" title="class in java.io">UnsupportedEncodingException</a></code> - If the named charset is not supported</dd><dt><span class="strong">Since:</span></dt>
<dd>JDK1.1</dd></dl>
</li>
</ul>
<a name="String(byte[], java.nio.charset.Charset)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>String</h4>
<pre>public&nbsp;String(byte[]&nbsp;bytes,
<a href="../../java/nio/charset/Charset.html" title="class in java.nio.charset">Charset</a>&nbsp;charset)</pre>
<div class="block">Constructs a new <code>String</code> by decoding the specified array of
bytes using the specified <a href="../../java/nio/charset/Charset.html" title="class in java.nio.charset">charset</a>.
The length of the new <code>String</code> is a function of the charset, and
hence may not be equal to the length of the byte array.
<p> This method always replaces malformed-input and unmappable-character
sequences with this charset's default replacement string. The <a href="../../java/nio/charset/CharsetDecoder.html" title="class in java.nio.charset"><code>CharsetDecoder</code></a> class should be used when more control
over the decoding process is required.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>bytes</code> - The bytes to be decoded into characters</dd><dd><code>charset</code> - The <a href="../../java/nio/charset/Charset.html" title="class in java.nio.charset">charset</a> to be used to
decode the <code>bytes</code></dd><dt><span class="strong">Since:</span></dt>
<dd>1.6</dd></dl>
</li>
</ul>
<a name="String(byte[], int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>String</h4>
<pre>public&nbsp;String(byte[]&nbsp;bytes,
int&nbsp;offset,
int&nbsp;length)</pre>
<div class="block">Constructs a new <code>String</code> by decoding the specified subarray of
bytes using the platform's default charset. The length of the new
<code>String</code> is a function of the charset, and hence may not be equal
to the length of the subarray.
<p> The behavior of this constructor when the given bytes are not valid
in the default charset is unspecified. The <a href="../../java/nio/charset/CharsetDecoder.html" title="class in java.nio.charset"><code>CharsetDecoder</code></a> class should be used when more control
over the decoding process is required.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>bytes</code> - The bytes to be decoded into characters</dd><dd><code>offset</code> - The index of the first byte to decode</dd><dd><code>length</code> - The number of bytes to decode</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../java/lang/IndexOutOfBoundsException.html" title="class in java.lang">IndexOutOfBoundsException</a></code> - If the <code>offset</code> and the <code>length</code> arguments index
characters outside the bounds of the <code>bytes</code> array</dd><dt><span class="strong">Since:</span></dt>
<dd>JDK1.1</dd></dl>
</li>
</ul>
<a name="String(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>String</h4>
<pre>public&nbsp;String(byte[]&nbsp;bytes)</pre>
<div class="block">Constructs a new <code>String</code> by decoding the specified array of bytes
using the platform's default charset. The length of the new <code>String</code> is a function of the charset, and hence may not be equal to the
length of the byte array.
<p> The behavior of this constructor when the given bytes are not valid
in the default charset is unspecified. The <a href="../../java/nio/charset/CharsetDecoder.html" title="class in java.nio.charset"><code>CharsetDecoder</code></a> class should be used when more control
over the decoding process is required.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>bytes</code> - The bytes to be decoded into characters</dd><dt><span class="strong">Since:</span></dt>
<dd>JDK1.1</dd></dl>
</li>
</ul>
<a name="String(java.lang.StringBuffer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>String</h4>
<pre>public&nbsp;String(<a href="../../java/lang/StringBuffer.html" title="class in java.lang">StringBuffer</a>&nbsp;buffer)</pre>
<div class="block">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.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>buffer</code> - A <code>StringBuffer</code></dd></dl>
</li>
</ul>
<a name="String(java.lang.StringBuilder)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>String</h4>
<pre>public&nbsp;String(<a href="../../java/lang/StringBuilder.html" title="class in java.lang">StringBuilder</a>&nbsp;builder)</pre>
<div class="block">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.
<p> This constructor is provided to ease migration to <code>StringBuilder</code>. Obtaining a string from a string builder via the <code>toString</code> method is likely to run faster and is generally preferred.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>builder</code> - A <code>StringBuilder</code></dd><dt><span class="strong">Since:</span></dt>
<dd>1.5</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="length()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>length</h4>
<pre>public&nbsp;int&nbsp;length()</pre>
<div class="block">Returns the length of this string.
The length is equal to the number of <a href="Character.html#unicode">Unicode
code units</a> in the string.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../java/lang/CharSequence.html#length()">length</a></code>&nbsp;in interface&nbsp;<code><a href="../../java/lang/CharSequence.html" title="interface in java.lang">CharSequence</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the length of the sequence of characters represented by this
object.</dd></dl>
</li>
</ul>
<a name="isEmpty()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEmpty</h4>
<pre>public&nbsp;boolean&nbsp;isEmpty()</pre>
<div class="block">Returns <tt>true</tt> if, and only if, <a href="../../java/lang/String.html#length()"><code>length()</code></a> is <tt>0</tt>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><tt>true</tt> if <a href="../../java/lang/String.html#length()"><code>length()</code></a> is <tt>0</tt>, otherwise
<tt>false</tt></dd><dt><span class="strong">Since:</span></dt>
<dd>1.6</dd></dl>
</li>
</ul>
<a name="charAt(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>charAt</h4>
<pre>public&nbsp;char&nbsp;charAt(int&nbsp;index)</pre>
<div class="block">Returns the <code>char</code> value at the
specified index. An index ranges from <code>0</code> to
<code>length() - 1</code>. The first <code>char</code> value of the sequence
is at index <code>0</code>, the next at index <code>1</code>,
and so on, as for array indexing.
<p>If the <code>char</code> value specified by the index is a
<a href="Character.html#unicode">surrogate</a>, the surrogate
value is returned.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../java/lang/CharSequence.html#charAt(int)">charAt</a></code>&nbsp;in interface&nbsp;<code><a href="../../java/lang/CharSequence.html" title="interface in java.lang">CharSequence</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - the index of the <code>char</code> value.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the <code>char</code> value at the specified index of this string.
The first <code>char</code> value is at index <code>0</code>.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../java/lang/IndexOutOfBoundsException.html" title="class in java.lang">IndexOutOfBoundsException</a></code> - if the <code>index</code>
argument is negative or not less than the length of this
string.</dd></dl>
</li>
</ul>
<a name="codePointAt(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>codePointAt</h4>
<pre>public&nbsp;int&nbsp;codePointAt(int&nbsp;index)</pre>
<div class="block">Returns the character (Unicode code point) at the specified
index. The index refers to <code>char</code> values
(Unicode code units) and ranges from <code>0</code> to
<a href="../../java/lang/String.html#length()"><code>length()</code></a><code> - 1</code>.
<p> If the <code>char</code> value specified at the given index
is in the high-surrogate range, the following index is less
than the length of this <code>String</code>, and the
<code>char</code> 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 <code>char</code> value at the given index is returned.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - the index to the <code>char</code> values</dd>
<dt><span class="strong">Returns:</span></dt><dd>the code point value of the character at the
<code>index</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../java/lang/IndexOutOfBoundsException.html" title="class in java.lang">IndexOutOfBoundsException</a></code> - if the <code>index</code>
argument is negative or not less than the length of this
string.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.5</dd></dl>
</li>
</ul>
<a name="codePointBefore(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>codePointBefore</h4>
<pre>public&nbsp;int&nbsp;codePointBefore(int&nbsp;index)</pre>
<div class="block">Returns the character (Unicode code point) before the specified
index. The index refers to <code>char</code> values
(Unicode code units) and ranges from <code>1</code> to <a href="../../java/lang/CharSequence.html#length()"><code>length</code></a>.
<p> If the <code>char</code> value at <code>(index - 1)</code>
is in the low-surrogate range, <code>(index - 2)</code> is not
negative, and the <code>char</code> value at <code>(index -
2)</code> is in the high-surrogate range, then the
supplementary code point value of the surrogate pair is
returned. If the <code>char</code> value at <code>index -
1</code> is an unpaired low-surrogate or a high-surrogate, the
surrogate value is returned.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - the index following the code point that should be returned</dd>
<dt><span class="strong">Returns:</span></dt><dd>the Unicode code point value before the given index.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../java/lang/IndexOutOfBoundsException.html" title="class in java.lang">IndexOutOfBoundsException</a></code> - if the <code>index</code>
argument is less than 1 or greater than the length
of this string.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.5</dd></dl>
</li>
</ul>
<a name="codePointCount(int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>codePointCount</h4>
<pre>public&nbsp;int&nbsp;codePointCount(int&nbsp;beginIndex,
int&nbsp;endIndex)</pre>
<div class="block">Returns the number of Unicode code points in the specified text
range of this <code>String</code>. The text range begins at the
specified <code>beginIndex</code> and extends to the
<code>char</code> at index <code>endIndex - 1</code>. Thus the
length (in <code>char</code>s) of the text range is
<code>endIndex-beginIndex</code>. Unpaired surrogates within
the text range count as one code point each.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>beginIndex</code> - the index to the first <code>char</code> of
the text range.</dd><dd><code>endIndex</code> - the index after the last <code>char</code> of
the text range.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the number of Unicode code points in the specified text
range</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../java/lang/IndexOutOfBoundsException.html" title="class in java.lang">IndexOutOfBoundsException</a></code> - if the
<code>beginIndex</code> is negative, or <code>endIndex</code>
is larger than the length of this <code>String</code>, or
<code>beginIndex</code> is larger than <code>endIndex</code>.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.5</dd></dl>
</li>
</ul>
<a name="offsetByCodePoints(int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>offsetByCodePoints</h4>
<pre>public&nbsp;int&nbsp;offsetByCodePoints(int&nbsp;index,
int&nbsp;codePointOffset)</pre>
<div class="block">Returns the index within this <code>String</code> that is
offset from the given <code>index</code> by
<code>codePointOffset</code> code points. Unpaired surrogates
within the text range given by <code>index</code> and
<code>codePointOffset</code> count as one code point each.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - the index to be offset</dd><dd><code>codePointOffset</code> - the offset in code points</dd>
<dt><span class="strong">Returns:</span></dt><dd>the index within this <code>String</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../java/lang/IndexOutOfBoundsException.html" title="class in java.lang">IndexOutOfBoundsException</a></code> - if <code>index</code>
is negative or larger then the length of this
<code>String</code>, or if <code>codePointOffset</code> is positive
and the substring starting with <code>index</code> has fewer
than <code>codePointOffset</code> code points,
or if <code>codePointOffset</code> is negative and the substring
before <code>index</code> has fewer than the absolute value
of <code>codePointOffset</code> code points.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.5</dd></dl>
</li>
</ul>
<a name="getChars(int, int, char[], int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChars</h4>
<pre>public&nbsp;void&nbsp;getChars(int&nbsp;srcBegin,
int&nbsp;srcEnd,
char[]&nbsp;dst,
int&nbsp;dstBegin)</pre>
<div class="block">Copies characters from this string into the destination character
array.
<p>
The first character to be copied is at index <code>srcBegin</code>;
the last character to be copied is at index <code>srcEnd-1</code>
(thus the total number of characters to be copied is
<code>srcEnd-srcBegin</code>). The characters are copied into the
subarray of <code>dst</code> starting at index <code>dstBegin</code>
and ending at index:
<p><blockquote><pre>
dstbegin + (srcEnd-srcBegin) - 1
</pre></blockquote></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>srcBegin</code> - index of the first character in the string
to copy.</dd><dd><code>srcEnd</code> - index after the last character in the string
to copy.</dd><dd><code>dst</code> - the destination array.</dd><dd><code>dstBegin</code> - the start offset in the destination array.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../java/lang/IndexOutOfBoundsException.html" title="class in java.lang">IndexOutOfBoundsException</a></code> - If any of the following
is true:
<ul><li><code>srcBegin</code> is negative.
<li><code>srcBegin</code> is greater than <code>srcEnd</code>
<li><code>srcEnd</code> is greater than the length of this
string
<li><code>dstBegin</code> is negative
<li><code>dstBegin+(srcEnd-srcBegin)</code> is larger than
<code>dst.length</code></ul></dd></dl>
</li>
</ul>
<a name="getBytes(int, int, byte[], int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBytes</h4>
<pre><a href="../../java/lang/Deprecated.html" title="annotation in java.lang">@Deprecated</a>
public&nbsp;void&nbsp;getBytes(int&nbsp;srcBegin,
int&nbsp;srcEnd,
byte[]&nbsp;dst,
int&nbsp;dstBegin)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>This method does not properly convert characters into
bytes. As of JDK&nbsp;1.1, the preferred way to do this is via the
<a href="../../java/lang/String.html#getBytes()"><code>getBytes()</code></a> method, which uses the platform's default charset.</i></div>
<div class="block">Copies characters from this string into the destination byte array. Each
byte receives the 8 low-order bits of the corresponding character. The
eight high-order bits of each character are not copied and do not
participate in the transfer in any way.
<p> The first character to be copied is at index <code>srcBegin</code>; the
last character to be copied is at index <code>srcEnd-1</code>. The total
number of characters to be copied is <code>srcEnd-srcBegin</code>. The
characters, converted to bytes, are copied into the subarray of <code>dst</code> starting at index <code>dstBegin</code> and ending at index:
<blockquote><pre>
dstbegin + (srcEnd-srcBegin) - 1
</pre></blockquote></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>srcBegin</code> - Index of the first character in the string to copy</dd><dd><code>srcEnd</code> - Index after the last character in the string to copy</dd><dd><code>dst</code> - The destination array</dd><dd><code>dstBegin</code> - The start offset in the destination array</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../java/lang/IndexOutOfBoundsException.html" title="class in java.lang">IndexOutOfBoundsException</a></code> - If any of the following is true:
<ul>
<li> <code>srcBegin</code> is negative
<li> <code>srcBegin</code> is greater than <code>srcEnd</code>
<li> <code>srcEnd</code> is greater than the length of this String
<li> <code>dstBegin</code> is negative
<li> <code>dstBegin+(srcEnd-srcBegin)</code> is larger than <code>dst.length</code>
</ul></dd></dl>
</li>
</ul>
<a name="getBytes(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBytes</h4>
<pre>public&nbsp;byte[]&nbsp;getBytes(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;charsetName)
throws <a href="../../java/io/UnsupportedEncodingException.html" title="class in java.io">UnsupportedEncodingException</a></pre>
<div class="block">Encodes this <code>String</code> into a sequence of bytes using the named
charset, storing the result into a new byte array.
<p> The behavior of this method when this string cannot be encoded in
the given charset is unspecified. The <a href="../../java/nio/charset/CharsetEncoder.html" title="class in java.nio.charset"><code>CharsetEncoder</code></a> class should be used when more control
over the encoding process is required.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>charsetName</code> - The name of a supported <a href="../../java/nio/charset/Charset.html" title="class in java.nio.charset">charset</a></dd>
<dt><span class="strong">Returns:</span></dt><dd>The resultant byte array</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../java/io/UnsupportedEncodingException.html" title="class in java.io">UnsupportedEncodingException</a></code> - If the named charset is not supported</dd><dt><span class="strong">Since:</span></dt>
<dd>JDK1.1</dd></dl>
</li>
</ul>
<a name="getBytes(java.nio.charset.Charset)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBytes</h4>
<pre>public&nbsp;byte[]&nbsp;getBytes(<a href="../../java/nio/charset/Charset.html" title="class in java.nio.charset">Charset</a>&nbsp;charset)</pre>
<div class="block">Encodes this <code>String</code> into a sequence of bytes using the given
<a href="../../java/nio/charset/Charset.html" title="class in java.nio.charset">charset</a>, storing the result into a
new byte array.
<p> This method always replaces malformed-input and unmappable-character
sequences with this charset's default replacement byte array. The
<a href="../../java/nio/charset/CharsetEncoder.html" title="class in java.nio.charset"><code>CharsetEncoder</code></a> class should be used when more
control over the encoding process is required.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>charset</code> - The <a href="../../java/nio/charset/Charset.html" title="class in java.nio.charset">Charset</a> to be used to encode
the <code>String</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>The resultant byte array</dd><dt><span class="strong">Since:</span></dt>
<dd>1.6</dd></dl>
</li>
</ul>
<a name="getBytes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBytes</h4>
<pre>public&nbsp;byte[]&nbsp;getBytes()</pre>
<div class="block">Encodes this <code>String</code> into a sequence of bytes using the
platform's default charset, storing the result into a new byte array.
<p> The behavior of this method when this string cannot be encoded in
the default charset is unspecified. The <a href="../../java/nio/charset/CharsetEncoder.html" title="class in java.nio.charset"><code>CharsetEncoder</code></a> class should be used when more control
over the encoding process is required.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The resultant byte array</dd><dt><span class="strong">Since:</span></dt>
<dd>JDK1.1</dd></dl>
</li>
</ul>
<a name="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(<a href="../../java/lang/Object.html" title="class in java.lang">Object</a>&nbsp;anObject)</pre>
<div class="block">Compares this string to the specified object. The result is <code>true</code> if and only if the argument is not <code>null</code> and is a <code>String</code> object that represents the same sequence of characters as this
object.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../java/lang/Object.html#equals(java.lang.Object)">equals</a></code>&nbsp;in class&nbsp;<code><a href="../../java/lang/Object.html" title="class in java.lang">Object</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>anObject</code> - The object to compare this <code>String</code> against</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the given object represents a <code>String</code>
equivalent to this string, <code>false</code> otherwise</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../java/lang/String.html#compareTo(java.lang.String)"><code>compareTo(String)</code></a>,
<a href="../../java/lang/String.html#equalsIgnoreCase(java.lang.String)"><code>equalsIgnoreCase(String)</code></a></dd></dl>
</li>
</ul>
<a name="contentEquals(java.lang.StringBuffer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contentEquals</h4>
<pre>public&nbsp;boolean&nbsp;contentEquals(<a href="../../java/lang/StringBuffer.html" title="class in java.lang">StringBuffer</a>&nbsp;sb)</pre>
<div class="block">Compares this string to the specified <code>StringBuffer</code>. The result
is <code>true</code> if and only if this <code>String</code> represents the same
sequence of characters as the specified <code>StringBuffer</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sb</code> - The <code>StringBuffer</code> to compare this <code>String</code> against</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if this <code>String</code> represents the same
sequence of characters as the specified <code>StringBuffer</code>,
<code>false</code> otherwise</dd><dt><span class="strong">Since:</span></dt>
<dd>1.4</dd></dl>
</li>
</ul>
<a name="contentEquals(java.lang.CharSequence)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contentEquals</h4>
<pre>public&nbsp;boolean&nbsp;contentEquals(<a href="../../java/lang/CharSequence.html" title="interface in java.lang">CharSequence</a>&nbsp;cs)</pre>
<div class="block">Compares this string to the specified <code>CharSequence</code>. The result
is <code>true</code> if and only if this <code>String</code> represents the same
sequence of char values as the specified sequence.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cs</code> - The sequence to compare this <code>String</code> against</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if this <code>String</code> represents the same
sequence of char values as the specified sequence, <code>false</code> otherwise</dd><dt><span class="strong">Since:</span></dt>
<dd>1.5</dd></dl>
</li>
</ul>
<a name="equalsIgnoreCase(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equalsIgnoreCase</h4>
<pre>public&nbsp;boolean&nbsp;equalsIgnoreCase(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;anotherString)</pre>
<div class="block">Compares this <code>String</code> to another <code>String</code>, 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.
<p> Two characters <code>c1</code> and <code>c2</code> are considered the same
ignoring case if at least one of the following is true:
<ul>
<li> The two characters are the same (as compared by the
<code>==</code> operator)
<li> Applying the method <a href="../../java/lang/Character.html#toUpperCase(char)"><code>Character.toUpperCase(char)</code></a> to each character
produces the same result
<li> Applying the method <a href="../../java/lang/Character.html#toLowerCase(char)"><code>Character.toLowerCase(char)</code></a> to each character
produces the same result
</ul></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>anotherString</code> - The <code>String</code> to compare this <code>String</code> against</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the argument is not <code>null</code> and it
represents an equivalent <code>String</code> ignoring case; <code>false</code> otherwise</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../java/lang/String.html#equals(java.lang.Object)"><code>equals(Object)</code></a></dd></dl>
</li>
</ul>
<a name="compareTo(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compareTo</h4>
<pre>public&nbsp;int&nbsp;compareTo(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;anotherString)</pre>
<div class="block">Compares two strings lexicographically.
The comparison is based on the Unicode value of each character in
the strings. The character sequence represented by this
<code>String</code> object is compared lexicographically to the
character sequence represented by the argument string. The result is
a negative integer if this <code>String</code> object
lexicographically precedes the argument string. The result is a
positive integer if this <code>String</code> object lexicographically
follows the argument string. The result is zero if the strings
are equal; <code>compareTo</code> returns <code>0</code> exactly when
the <a href="../../java/lang/String.html#equals(java.lang.Object)"><code>equals(Object)</code></a> method would return <code>true</code>.
<p>
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 <i>k</i> be the smallest such index; then the string
whose character at position <i>k</i> has the smaller value, as
determined by using the &lt; operator, lexicographically precedes the
other string. In this case, <code>compareTo</code> returns the
difference of the two character values at position <code>k</code> in
the two string -- that is, the value:
<blockquote><pre>
this.charAt(k)-anotherString.charAt(k)
</pre></blockquote>
If there is no index position at which they differ, then the shorter
string lexicographically precedes the longer string. In this case,
<code>compareTo</code> returns the difference of the lengths of the
strings -- that is, the value:
<blockquote><pre>
this.length()-anotherString.length()
</pre></blockquote></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../java/lang/Comparable.html#compareTo(T)">compareTo</a></code>&nbsp;in interface&nbsp;<code><a href="../../java/lang/Comparable.html" title="interface in java.lang">Comparable</a>&lt;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&gt;</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>anotherString</code> - the <code>String</code> to be compared.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the value <code>0</code> if the argument string is equal to
this string; a value less than <code>0</code> if this string
is lexicographically less than the string argument; and a
value greater than <code>0</code> if this string is
lexicographically greater than the string argument.</dd></dl>
</li>
</ul>
<a name="compareToIgnoreCase(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compareToIgnoreCase</h4>
<pre>public&nbsp;int&nbsp;compareToIgnoreCase(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;str)</pre>
<div class="block">Compares two strings lexicographically, ignoring case
differences. This method returns an integer whose sign is that of
calling <code>compareTo</code> with normalized versions of the strings
where case differences have been eliminated by calling
<code>Character.toLowerCase(Character.toUpperCase(character))</code> on
each character.
<p>
Note that this method does <em>not</em> take locale into account,
and will result in an unsatisfactory ordering for certain locales.
The java.text package provides <em>collators</em> to allow
locale-sensitive ordering.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>str</code> - the <code>String</code> to be compared.</dd>
<dt><span class="strong">Returns:</span></dt><dd>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.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.2</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../java/text/Collator.html#compare(java.lang.String, java.lang.String)"><code>Collator.compare(String, String)</code></a></dd></dl>
</li>
</ul>
<a name="regionMatches(int, java.lang.String, int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>regionMatches</h4>
<pre>public&nbsp;boolean&nbsp;regionMatches(int&nbsp;toffset,
<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;other,
int&nbsp;ooffset,
int&nbsp;len)</pre>
<div class="block">Tests if two string regions are equal.
<p>
A substring of this <tt>String</tt> 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
<tt>String</tt> object to be compared begins at index <tt>toffset</tt>
and has length <tt>len</tt>. The substring of other to be compared
begins at index <tt>ooffset</tt> and has length <tt>len</tt>. The
result is <tt>false</tt> if and only if at least one of the following
is true:
<ul><li><tt>toffset</tt> is negative.
<li><tt>ooffset</tt> is negative.
<li><tt>toffset+len</tt> is greater than the length of this
<tt>String</tt> object.
<li><tt>ooffset+len</tt> is greater than the length of the other
argument.
<li>There is some nonnegative integer <i>k</i> less than <tt>len</tt>
such that:
<tt>this.charAt(toffset+<i>k</i>)&nbsp;!=&nbsp;other.charAt(ooffset+<i>k</i>)</tt>
</ul></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>toffset</code> - the starting offset of the subregion in this string.</dd><dd><code>other</code> - the string argument.</dd><dd><code>ooffset</code> - the starting offset of the subregion in the string
argument.</dd><dd><code>len</code> - the number of characters to compare.</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the specified subregion of this string
exactly matches the specified subregion of the string argument;
<code>false</code> otherwise.</dd></dl>
</li>
</ul>
<a name="regionMatches(boolean, int, java.lang.String, int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>regionMatches</h4>
<pre>public&nbsp;boolean&nbsp;regionMatches(boolean&nbsp;ignoreCase,
int&nbsp;toffset,
<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;other,
int&nbsp;ooffset,
int&nbsp;len)</pre>
<div class="block">Tests if two string regions are equal.
<p>
A substring of this <tt>String</tt> object is compared to a substring
of the argument <tt>other</tt>. The result is <tt>true</tt> if these
substrings represent character sequences that are the same, ignoring
case if and only if <tt>ignoreCase</tt> is true. The substring of
this <tt>String</tt> object to be compared begins at index
<tt>toffset</tt> and has length <tt>len</tt>. The substring of
<tt>other</tt> to be compared begins at index <tt>ooffset</tt> and
has length <tt>len</tt>. The result is <tt>false</tt> if and only if
at least one of the following is true:
<ul><li><tt>toffset</tt> is negative.
<li><tt>ooffset</tt> is negative.
<li><tt>toffset+len</tt> is greater than the length of this
<tt>String</tt> object.
<li><tt>ooffset+len</tt> is greater than the length of the other
argument.
<li><tt>ignoreCase</tt> is <tt>false</tt> and there is some nonnegative
integer <i>k</i> less than <tt>len</tt> such that:
<blockquote><pre>
this.charAt(toffset+k) != other.charAt(ooffset+k)
</pre></blockquote>
<li><tt>ignoreCase</tt> is <tt>true</tt> and there is some nonnegative
integer <i>k</i> less than <tt>len</tt> such that:
<blockquote><pre>
Character.toLowerCase(this.charAt(toffset+k)) !=
Character.toLowerCase(other.charAt(ooffset+k))
</pre></blockquote>
and:
<blockquote><pre>
Character.toUpperCase(this.charAt(toffset+k)) !=
Character.toUpperCase(other.charAt(ooffset+k))
</pre></blockquote>
</ul></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ignoreCase</code> - if <code>true</code>, ignore case when comparing
characters.</dd><dd><code>toffset</code> - the starting offset of the subregion in this
string.</dd><dd><code>other</code> - the string argument.</dd><dd><code>ooffset</code> - the starting offset of the subregion in the string
argument.</dd><dd><code>len</code> - the number of characters to compare.</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the specified subregion of this string
matches the specified subregion of the string argument;
<code>false</code> otherwise. Whether the matching is exact
or case insensitive depends on the <code>ignoreCase</code>
argument.</dd></dl>
</li>
</ul>
<a name="startsWith(java.lang.String, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startsWith</h4>
<pre>public&nbsp;boolean&nbsp;startsWith(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;prefix,
int&nbsp;toffset)</pre>
<div class="block">Tests if the substring of this string beginning at the
specified index starts with the specified prefix.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>prefix</code> - the prefix.</dd><dd><code>toffset</code> - where to begin looking in this string.</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the character sequence represented by the
argument is a prefix of the substring of this object starting
at index <code>toffset</code>; <code>false</code> otherwise.
The result is <code>false</code> if <code>toffset</code> is
negative or greater than the length of this
<code>String</code> object; otherwise the result is the same
as the result of the expression
<pre>
this.substring(toffset).startsWith(prefix)
</pre></dd></dl>
</li>
</ul>
<a name="startsWith(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startsWith</h4>
<pre>public&nbsp;boolean&nbsp;startsWith(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;prefix)</pre>
<div class="block">Tests if this string starts with the specified prefix.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>prefix</code> - the prefix.</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the character sequence represented by the
argument is a prefix of the character sequence represented by
this string; <code>false</code> otherwise.
Note also that <code>true</code> will be returned if the
argument is an empty string or is equal to this
<code>String</code> object as determined by the
<a href="../../java/lang/String.html#equals(java.lang.Object)"><code>equals(Object)</code></a> method.</dd><dt><span class="strong">Since:</span></dt>
<dd>1. 0</dd></dl>
</li>
</ul>
<a name="endsWith(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>endsWith</h4>
<pre>public&nbsp;boolean&nbsp;endsWith(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;suffix)</pre>
<div class="block">Tests if this string ends with the specified suffix.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>suffix</code> - the suffix.</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the character sequence represented by the
argument is a suffix of the character sequence represented by
this object; <code>false</code> otherwise. Note that the
result will be <code>true</code> if the argument is the
empty string or is equal to this <code>String</code> object
as determined by the <a href="../../java/lang/String.html#equals(java.lang.Object)"><code>equals(Object)</code></a> method.</dd></dl>
</li>
</ul>
<a name="hashCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<div class="block">Returns a hash code for this string. The hash code for a
<code>String</code> object is computed as
<blockquote><pre>
s[0]*31^(n-1) + s[1]*31^(n-2) + ... + s[n-1]
</pre></blockquote>
using <code>int</code> arithmetic, where <code>s[i]</code> is the
<i>i</i>th character of the string, <code>n</code> is the length of
the string, and <code>^</code> indicates exponentiation.
(The hash value of the empty string is zero.)</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../java/lang/Object.html#hashCode()">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="../../java/lang/Object.html" title="class in java.lang">Object</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>a hash code value for this object.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../java/lang/Object.html#equals(java.lang.Object)"><code>Object.equals(java.lang.Object)</code></a>,
<a href="../../java/lang/System.html#identityHashCode(java.lang.Object)"><code>System.identityHashCode(java.lang.Object)</code></a></dd></dl>
</li>
</ul>
<a name="indexOf(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>indexOf</h4>
<pre>public&nbsp;int&nbsp;indexOf(int&nbsp;ch)</pre>
<div class="block">Returns the index within this string of the first occurrence of
the specified character. If a character with value
<code>ch</code> occurs in the character sequence represented by
this <code>String</code> object, then the index (in Unicode
code units) of the first such occurrence is returned. For
values of <code>ch</code> in the range from 0 to 0xFFFF
(inclusive), this is the smallest value <i>k</i> such that:
<blockquote><pre>
this.charAt(<i>k</i>) == ch
</pre></blockquote>
is true. For other values of <code>ch</code>, it is the
smallest value <i>k</i> such that:
<blockquote><pre>
this.codePointAt(<i>k</i>) == ch
</pre></blockquote>
is true. In either case, if no such character occurs in this
string, then <code>-1</code> is returned.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ch</code> - a character (Unicode code point).</dd>
<dt><span class="strong">Returns:</span></dt><dd>the index of the first occurrence of the character in the
character sequence represented by this object, or
<code>-1</code> if the character does not occur.</dd></dl>
</li>
</ul>
<a name="indexOf(int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>indexOf</h4>
<pre>public&nbsp;int&nbsp;indexOf(int&nbsp;ch,
int&nbsp;fromIndex)</pre>
<div class="block">Returns the index within this string of the first occurrence of the
specified character, starting the search at the specified index.
<p>
If a character with value <code>ch</code> occurs in the
character sequence represented by this <code>String</code>
object at an index no smaller than <code>fromIndex</code>, then
the index of the first such occurrence is returned. For values
of <code>ch</code> in the range from 0 to 0xFFFF (inclusive),
this is the smallest value <i>k</i> such that:
<blockquote><pre>
(this.charAt(<i>k</i>) == ch) && (<i>k</i> &gt;= fromIndex)
</pre></blockquote>
is true. For other values of <code>ch</code>, it is the
smallest value <i>k</i> such that:
<blockquote><pre>
(this.codePointAt(<i>k</i>) == ch) && (<i>k</i> &gt;= fromIndex)
</pre></blockquote>
is true. In either case, if no such character occurs in this
string at or after position <code>fromIndex</code>, then
<code>-1</code> is returned.
<p>
There is no restriction on the value of <code>fromIndex</code>. 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: <code>-1</code> is returned.
<p>All indices are specified in <code>char</code> values
(Unicode code units).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ch</code> - a character (Unicode code point).</dd><dd><code>fromIndex</code> - the index to start the search from.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the index of the first occurrence of the character in the
character sequence represented by this object that is greater
than or equal to <code>fromIndex</code>, or <code>-1</code>
if the character does not occur.</dd></dl>
</li>
</ul>
<a name="lastIndexOf(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lastIndexOf</h4>
<pre>public&nbsp;int&nbsp;lastIndexOf(int&nbsp;ch)</pre>
<div class="block">Returns the index within this string of the last occurrence of
the specified character. For values of <code>ch</code> in the
range from 0 to 0xFFFF (inclusive), the index (in Unicode code
units) returned is the largest value <i>k</i> such that:
<blockquote><pre>
this.charAt(<i>k</i>) == ch
</pre></blockquote>
is true. For other values of <code>ch</code>, it is the
largest value <i>k</i> such that:
<blockquote><pre>
this.codePointAt(<i>k</i>) == ch
</pre></blockquote>
is true. In either case, if no such character occurs in this
string, then <code>-1</code> is returned. The
<code>String</code> is searched backwards starting at the last
character.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ch</code> - a character (Unicode code point).</dd>
<dt><span class="strong">Returns:</span></dt><dd>the index of the last occurrence of the character in the
character sequence represented by this object, or
<code>-1</code> if the character does not occur.</dd></dl>
</li>
</ul>
<a name="lastIndexOf(int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lastIndexOf</h4>
<pre>public&nbsp;int&nbsp;lastIndexOf(int&nbsp;ch,
int&nbsp;fromIndex)</pre>
<div class="block">Returns the index within this string of the last occurrence of
the specified character, searching backward starting at the
specified index. For values of <code>ch</code> in the range
from 0 to 0xFFFF (inclusive), the index returned is the largest
value <i>k</i> such that:
<blockquote><pre>
(this.charAt(<i>k</i>) == ch) && (<i>k</i> &lt;= fromIndex)
</pre></blockquote>
is true. For other values of <code>ch</code>, it is the
largest value <i>k</i> such that:
<blockquote><pre>
(this.codePointAt(<i>k</i>) == ch) && (<i>k</i> &lt;= fromIndex)
</pre></blockquote>
is true. In either case, if no such character occurs in this
string at or before position <code>fromIndex</code>, then
<code>-1</code> is returned.
<p>All indices are specified in <code>char</code> values
(Unicode code units).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ch</code> - a character (Unicode code point).</dd><dd><code>fromIndex</code> - the index to start the search from. There is no
restriction on the value of <code>fromIndex</code>. 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.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the index of the last occurrence of the character in the
character sequence represented by this object that is less
than or equal to <code>fromIndex</code>, or <code>-1</code>
if the character does not occur before that point.</dd></dl>
</li>
</ul>
<a name="indexOf(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>indexOf</h4>
<pre>public&nbsp;int&nbsp;indexOf(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;str)</pre>
<div class="block">Returns the index within this string of the first occurrence of the
specified substring.
<p>The returned index is the smallest value <i>k</i> for which:
<blockquote><pre>
this.startsWith(str, <i>k</i>)
</pre></blockquote>
If no such value of <i>k</i> exists, then <code>-1</code> is returned.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>str</code> - the substring to search for.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the index of the first occurrence of the specified substring,
or <code>-1</code> if there is no such occurrence.</dd></dl>
</li>
</ul>
<a name="indexOf(java.lang.String, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>indexOf</h4>
<pre>public&nbsp;int&nbsp;indexOf(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;str,
int&nbsp;fromIndex)</pre>
<div class="block">Returns the index within this string of the first occurrence of the
specified substring, starting at the specified index.
<p>The returned index is the smallest value <i>k</i> for which:
<blockquote><pre>
<i>k</i> &gt;= fromIndex && this.startsWith(str, <i>k</i>)
</pre></blockquote>
If no such value of <i>k</i> exists, then <code>-1</code> is returned.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>str</code> - the substring to search for.</dd><dd><code>fromIndex</code> - the index from which to start the search.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the index of the first occurrence of the specified substring,
starting at the specified index,
or <code>-1</code> if there is no such occurrence.</dd></dl>
</li>
</ul>
<a name="lastIndexOf(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lastIndexOf</h4>
<pre>public&nbsp;int&nbsp;lastIndexOf(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;str)</pre>
<div class="block">Returns the index within this string of the last occurrence of the
specified substring. The last occurrence of the empty string ""
is considered to occur at the index value <code>this.length()</code>.
<p>The returned index is the largest value <i>k</i> for which:
<blockquote><pre>
this.startsWith(str, <i>k</i>)
</pre></blockquote>
If no such value of <i>k</i> exists, then <code>-1</code> is returned.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>str</code> - the substring to search for.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the index of the last occurrence of the specified substring,
or <code>-1</code> if there is no such occurrence.</dd></dl>
</li>
</ul>
<a name="lastIndexOf(java.lang.String, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lastIndexOf</h4>
<pre>public&nbsp;int&nbsp;lastIndexOf(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;str,
int&nbsp;fromIndex)</pre>
<div class="block">Returns the index within this string of the last occurrence of the
specified substring, searching backward starting at the specified index.
<p>The returned index is the largest value <i>k</i> for which:
<blockquote><pre>
<i>k</i> &lt;= fromIndex && this.startsWith(str, <i>k</i>)
</pre></blockquote>
If no such value of <i>k</i> exists, then <code>-1</code> is returned.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>str</code> - the substring to search for.</dd><dd><code>fromIndex</code> - the index to start the search from.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the index of the last occurrence of the specified substring,
searching backward from the specified index,
or <code>-1</code> if there is no such occurrence.</dd></dl>
</li>
</ul>
<a name="substring(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>substring</h4>
<pre>public&nbsp;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;substring(int&nbsp;beginIndex)</pre>
<div class="block">Returns a new string that is a substring of this string. The
substring begins with the character at the specified index and
extends to the end of this string. <p>
Examples:
<blockquote><pre>
"unhappy".substring(2) returns "happy"
"Harbison".substring(3) returns "bison"
"emptiness".substring(9) returns "" (an empty string)
</pre></blockquote></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>beginIndex</code> - the beginning index, inclusive.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the specified substring.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../java/lang/IndexOutOfBoundsException.html" title="class in java.lang">IndexOutOfBoundsException</a></code> - if
<code>beginIndex</code> is negative or larger than the
length of this <code>String</code> object.</dd></dl>
</li>
</ul>
<a name="substring(int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>substring</h4>
<pre>public&nbsp;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;substring(int&nbsp;beginIndex,
int&nbsp;endIndex)</pre>
<div class="block">Returns a new string that is a substring of this string. The
substring begins at the specified <code>beginIndex</code> and
extends to the character at index <code>endIndex - 1</code>.
Thus the length of the substring is <code>endIndex-beginIndex</code>.
<p>
Examples:
<blockquote><pre>
"hamburger".substring(4, 8) returns "urge"
"smiles".substring(1, 5) returns "mile"
</pre></blockquote></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>beginIndex</code> - the beginning index, inclusive.</dd><dd><code>endIndex</code> - the ending index, exclusive.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the specified substring.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../java/lang/IndexOutOfBoundsException.html" title="class in java.lang">IndexOutOfBoundsException</a></code> - if the
<code>beginIndex</code> is negative, or
<code>endIndex</code> is larger than the length of
this <code>String</code> object, or
<code>beginIndex</code> is larger than
<code>endIndex</code>.</dd></dl>
</li>
</ul>
<a name="subSequence(int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>subSequence</h4>
<pre>public&nbsp;<a href="../../java/lang/CharSequence.html" title="interface in java.lang">CharSequence</a>&nbsp;subSequence(int&nbsp;beginIndex,
int&nbsp;endIndex)</pre>
<div class="block">Returns a new character sequence that is a subsequence of this sequence.
<p> An invocation of this method of the form
<blockquote><pre>
str.subSequence(begin,&nbsp;end)</pre></blockquote>
behaves in exactly the same way as the invocation
<blockquote><pre>
str.substring(begin,&nbsp;end)</pre></blockquote>
This method is defined so that the <tt>String</tt> class can implement
the <a href="../../java/lang/CharSequence.html" title="interface in java.lang"><code>CharSequence</code></a> interface. </p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../java/lang/CharSequence.html#subSequence(int, int)">subSequence</a></code>&nbsp;in interface&nbsp;<code><a href="../../java/lang/CharSequence.html" title="interface in java.lang">CharSequence</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>beginIndex</code> - the begin index, inclusive.</dd><dd><code>endIndex</code> - the end index, exclusive.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the specified subsequence.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../java/lang/IndexOutOfBoundsException.html" title="class in java.lang">IndexOutOfBoundsException</a></code> - if <tt>beginIndex</tt> or <tt>endIndex</tt> are negative,
if <tt>endIndex</tt> is greater than <tt>length()</tt>,
or if <tt>beginIndex</tt> is greater than <tt>startIndex</tt></dd><dt><span class="strong">Since:</span></dt>
<dd>1.4</dd></dl>
</li>
</ul>
<a name="concat(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>concat</h4>
<pre>public&nbsp;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;concat(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;str)</pre>
<div class="block">Concatenates the specified string to the end of this string.
<p>
If the length of the argument string is <code>0</code>, then this
<code>String</code> object is returned. Otherwise, a new
<code>String</code> object is created, representing a character
sequence that is the concatenation of the character sequence
represented by this <code>String</code> object and the character
sequence represented by the argument string.<p>
Examples:
<blockquote><pre>
"cares".concat("s") returns "caress"
"to".concat("get").concat("her") returns "together"
</pre></blockquote></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>str</code> - the <code>String</code> that is concatenated to the end
of this <code>String</code>.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a string that represents the concatenation of this object's
characters followed by the string argument's characters.</dd></dl>
</li>
</ul>
<a name="replace(char, char)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>replace</h4>
<pre>public&nbsp;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;replace(char&nbsp;oldChar,
char&nbsp;newChar)</pre>
<div class="block">Returns a new string resulting from replacing all occurrences of
<code>oldChar</code> in this string with <code>newChar</code>.
<p>
If the character <code>oldChar</code> does not occur in the
character sequence represented by this <code>String</code> object,
then a reference to this <code>String</code> object is returned.
Otherwise, a new <code>String</code> object is created that
represents a character sequence identical to the character sequence
represented by this <code>String</code> object, except that every
occurrence of <code>oldChar</code> is replaced by an occurrence
of <code>newChar</code>.
<p>
Examples:
<blockquote><pre>
"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)
</pre></blockquote></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>oldChar</code> - the old character.</dd><dd><code>newChar</code> - the new character.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a string derived from this string by replacing every
occurrence of <code>oldChar</code> with <code>newChar</code>.</dd></dl>
</li>
</ul>
<a name="matches(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>matches</h4>
<pre>public&nbsp;boolean&nbsp;matches(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;regex)</pre>
<div class="block">Tells whether or not this string matches the given <a
href="../util/regex/Pattern.html#sum">regular expression</a>.
<p> An invocation of this method of the form
<i>str</i><tt>.matches(</tt><i>regex</i><tt>)</tt> yields exactly the
same result as the expression
<blockquote><tt> <a href="../../java/util/regex/Pattern.html" title="class in java.util.regex"><code>Pattern</code></a>.<a href="../../java/util/regex/Pattern.html#matches(java.lang.String, java.lang.CharSequence)"><code>matches</code></a>(</tt><i>regex</i><tt>,</tt> <i>str</i><tt>)</tt></blockquote></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>regex</code> - the regular expression to which this string is to be matched</dd>
<dt><span class="strong">Returns:</span></dt><dd><tt>true</tt> if, and only if, this string matches the
given regular expression</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../java/util/regex/PatternSyntaxException.html" title="class in java.util.regex">PatternSyntaxException</a></code> - if the regular expression's syntax is invalid</dd><dt><span class="strong">Since:</span></dt>
<dd>1.4</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../java/util/regex/Pattern.html" title="class in java.util.regex"><code>Pattern</code></a></dd></dl>
</li>
</ul>
<a name="contains(java.lang.CharSequence)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contains</h4>
<pre>public&nbsp;boolean&nbsp;contains(<a href="../../java/lang/CharSequence.html" title="interface in java.lang">CharSequence</a>&nbsp;s)</pre>
<div class="block">Returns true if and only if this string contains the specified
sequence of char values.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>s</code> - the sequence to search for</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if this string contains <code>s</code>, false otherwise</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../java/lang/NullPointerException.html" title="class in java.lang">NullPointerException</a></code> - if <code>s</code> is <code>null</code></dd><dt><span class="strong">Since:</span></dt>
<dd>1.5</dd></dl>
</li>
</ul>
<a name="replaceFirst(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>replaceFirst</h4>
<pre>public&nbsp;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;replaceFirst(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;regex,
<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;replacement)</pre>
<div class="block">Replaces the first substring of this string that matches the given <a
href="../util/regex/Pattern.html#sum">regular expression</a> with the
given replacement.
<p> An invocation of this method of the form
<i>str</i><tt>.replaceFirst(</tt><i>regex</i><tt>,</tt> <i>repl</i><tt>)</tt>
yields exactly the same result as the expression
<blockquote><tt>
<a href="../../java/util/regex/Pattern.html" title="class in java.util.regex"><code>Pattern</code></a>.<a href="../../java/util/regex/Pattern.html#compile(java.lang.String)"><code>compile</code></a>(</tt><i>regex</i><tt>).<a href="../../java/util/regex/Pattern.html#matcher(java.lang.CharSequence)"><code>matcher</code></a>(</tt><i>str</i><tt>).<a href="../../java/util/regex/Matcher.html#replaceFirst(java.lang.String)"><code>replaceFirst</code></a>(</tt><i>repl</i><tt>)</tt></blockquote>
<p>
Note that backslashes (<tt>\</tt>) and dollar signs (<tt>$</tt>) in the
replacement string may cause the results to be different than if it were
being treated as a literal replacement string; see
<a href="../../java/util/regex/Matcher.html#replaceFirst(java.lang.String)"><code>Matcher.replaceFirst(java.lang.String)</code></a>.
Use <a href="../../java/util/regex/Matcher.html#quoteReplacement(java.lang.String)"><code>Matcher.quoteReplacement(java.lang.String)</code></a> to suppress the special
meaning of these characters, if desired.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>regex</code> - the regular expression to which this string is to be matched</dd><dd><code>replacement</code> - the string to be substituted for the first match</dd>
<dt><span class="strong">Returns:</span></dt><dd>The resulting <tt>String</tt></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../java/util/regex/PatternSyntaxException.html" title="class in java.util.regex">PatternSyntaxException</a></code> - if the regular expression's syntax is invalid</dd><dt><span class="strong">Since:</span></dt>
<dd>1.4</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../java/util/regex/Pattern.html" title="class in java.util.regex"><code>Pattern</code></a></dd></dl>
</li>
</ul>
<a name="replaceAll(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>replaceAll</h4>
<pre>public&nbsp;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;replaceAll(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;regex,
<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;replacement)</pre>
<div class="block">Replaces each substring of this string that matches the given <a
href="../util/regex/Pattern.html#sum">regular expression</a> with the
given replacement.
<p> An invocation of this method of the form
<i>str</i><tt>.replaceAll(</tt><i>regex</i><tt>,</tt> <i>repl</i><tt>)</tt>
yields exactly the same result as the expression
<blockquote><tt>
<a href="../../java/util/regex/Pattern.html" title="class in java.util.regex"><code>Pattern</code></a>.<a href="../../java/util/regex/Pattern.html#compile(java.lang.String)"><code>compile</code></a>(</tt><i>regex</i><tt>).<a href="../../java/util/regex/Pattern.html#matcher(java.lang.CharSequence)"><code>matcher</code></a>(</tt><i>str</i><tt>).<a href="../../java/util/regex/Matcher.html#replaceAll(java.lang.String)"><code>replaceAll</code></a>(</tt><i>repl</i><tt>)</tt></blockquote>
<p>
Note that backslashes (<tt>\</tt>) and dollar signs (<tt>$</tt>) in the
replacement string may cause the results to be different than if it were
being treated as a literal replacement string; see
<a href="../../java/util/regex/Matcher.html#replaceAll(java.lang.String)"><code>Matcher.replaceAll</code></a>.
Use <a href="../../java/util/regex/Matcher.html#quoteReplacement(java.lang.String)"><code>Matcher.quoteReplacement(java.lang.String)</code></a> to suppress the special
meaning of these characters, if desired.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>regex</code> - the regular expression to which this string is to be matched</dd><dd><code>replacement</code> - the string to be substituted for each match</dd>
<dt><span class="strong">Returns:</span></dt><dd>The resulting <tt>String</tt></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../java/util/regex/PatternSyntaxException.html" title="class in java.util.regex">PatternSyntaxException</a></code> - if the regular expression's syntax is invalid</dd><dt><span class="strong">Since:</span></dt>
<dd>1.4</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../java/util/regex/Pattern.html" title="class in java.util.regex"><code>Pattern</code></a></dd></dl>
</li>
</ul>
<a name="replace(java.lang.CharSequence, java.lang.CharSequence)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>replace</h4>
<pre>public&nbsp;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;replace(<a href="../../java/lang/CharSequence.html" title="interface in java.lang">CharSequence</a>&nbsp;target,
<a href="../../java/lang/CharSequence.html" title="interface in java.lang">CharSequence</a>&nbsp;replacement)</pre>
<div class="block">Replaces each substring of this string that matches the literal target
sequence with the specified literal replacement sequence. The
replacement proceeds from the beginning of the string to the end, for
example, replacing "aa" with "b" in the string "aaa" will result in
"ba" rather than "ab".</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>target</code> - The sequence of char values to be replaced</dd><dd><code>replacement</code> - The replacement sequence of char values</dd>
<dt><span class="strong">Returns:</span></dt><dd>The resulting string</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../java/lang/NullPointerException.html" title="class in java.lang">NullPointerException</a></code> - if <code>target</code> or
<code>replacement</code> is <code>null</code>.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.5</dd></dl>
</li>
</ul>
<a name="split(java.lang.String, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>split</h4>
<pre>public&nbsp;<a href="../../java/lang/String.html" title="class in java.lang">String</a>[]&nbsp;split(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;regex,
int&nbsp;limit)</pre>
<div class="block">Splits this string around matches of the given
<a href="../util/regex/Pattern.html#sum">regular expression</a>.
<p> The array returned by this method contains each substring of this
string that is terminated by another substring that matches the given
expression or is terminated by the end of the string. The substrings in
the array are in the order in which they occur in this string. If the
expression does not match any part of the input then the resulting array
has just one element, namely this string.
<p> The <tt>limit</tt> parameter controls the number of times the
pattern is applied and therefore affects the length of the resulting
array. If the limit <i>n</i> is greater than zero then the pattern
will be applied at most <i>n</i>&nbsp;-&nbsp;1 times, the array's
length will be no greater than <i>n</i>, and the array's last entry
will contain all input beyond the last matched delimiter. If <i>n</i>
is non-positive then the pattern will be applied as many times as
possible and the array can have any length. If <i>n</i> 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.
<p> The string <tt>"boo:and:foo"</tt>, for example, yields the
following results with these parameters:
<blockquote><table cellpadding=1 cellspacing=0 summary="Split example showing regex, limit, and result">
<tr>
<th>Regex</th>
<th>Limit</th>
<th>Result</th>
</tr>
<tr><td align=center>:</td>
<td align=center>2</td>
<td><tt>{ "boo", "and:foo" }</tt></td></tr>
<tr><td align=center>:</td>
<td align=center>5</td>
<td><tt>{ "boo", "and", "foo" }</tt></td></tr>
<tr><td align=center>:</td>
<td align=center>-2</td>
<td><tt>{ "boo", "and", "foo" }</tt></td></tr>
<tr><td align=center>o</td>
<td align=center>5</td>
<td><tt>{ "b", "", ":and:f", "", "" }</tt></td></tr>
<tr><td align=center>o</td>
<td align=center>-2</td>
<td><tt>{ "b", "", ":and:f", "", "" }</tt></td></tr>
<tr><td align=center>o</td>
<td align=center>0</td>
<td><tt>{ "b", "", ":and:f" }</tt></td></tr>
</table></blockquote>
<p> An invocation of this method of the form
<i>str.</i><tt>split(</tt><i>regex</i><tt>,</tt>&nbsp;<i>n</i><tt>)</tt>
yields the same result as the expression
<blockquote>
<a href="../../java/util/regex/Pattern.html" title="class in java.util.regex"><code>Pattern</code></a>.<a href="../../java/util/regex/Pattern.html#compile(java.lang.String)"><code>compile</code></a><tt>(</tt><i>regex</i><tt>)</tt>.<a href="../../java/util/regex/Pattern.html#split(java.lang.CharSequence, int)"><code>split</code></a><tt>(</tt><i>str</i><tt>,</tt>&nbsp;<i>n</i><tt>)</tt>
</blockquote></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>regex</code> - the delimiting regular expression</dd><dd><code>limit</code> - the result threshold, as described above</dd>
<dt><span class="strong">Returns:</span></dt><dd>the array of strings computed by splitting this string
around matches of the given regular expression</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../java/util/regex/PatternSyntaxException.html" title="class in java.util.regex">PatternSyntaxException</a></code> - if the regular expression's syntax is invalid</dd><dt><span class="strong">Since:</span></dt>
<dd>1.4</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../java/util/regex/Pattern.html" title="class in java.util.regex"><code>Pattern</code></a></dd></dl>
</li>
</ul>
<a name="split(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>split</h4>
<pre>public&nbsp;<a href="../../java/lang/String.html" title="class in java.lang">String</a>[]&nbsp;split(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;regex)</pre>
<div class="block">Splits this string around matches of the given <a
href="../util/regex/Pattern.html#sum">regular expression</a>.
<p> This method works as if by invoking the two-argument <a href="../../java/lang/String.html#split(java.lang.String, int)"><code>split</code></a> method with the given expression and a limit
argument of zero. Trailing empty strings are therefore not included in
the resulting array.
<p> The string <tt>"boo:and:foo"</tt>, for example, yields the following
results with these expressions:
<blockquote><table cellpadding=1 cellspacing=0 summary="Split examples showing regex and result">
<tr>
<th>Regex</th>
<th>Result</th>
</tr>
<tr><td align=center>:</td>
<td><tt>{ "boo", "and", "foo" }</tt></td></tr>
<tr><td align=center>o</td>
<td><tt>{ "b", "", ":and:f" }</tt></td></tr>
</table></blockquote></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>regex</code> - the delimiting regular expression</dd>
<dt><span class="strong">Returns:</span></dt><dd>the array of strings computed by splitting this string
around matches of the given regular expression</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../java/util/regex/PatternSyntaxException.html" title="class in java.util.regex">PatternSyntaxException</a></code> - if the regular expression's syntax is invalid</dd><dt><span class="strong">Since:</span></dt>
<dd>1.4</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../java/util/regex/Pattern.html" title="class in java.util.regex"><code>Pattern</code></a></dd></dl>
</li>
</ul>
<a name="toLowerCase(java.util.Locale)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toLowerCase</h4>
<pre>public&nbsp;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;toLowerCase(<a href="../../java/util/Locale.html" title="class in java.util">Locale</a>&nbsp;locale)</pre>
<div class="block">Converts all of the characters in this <code>String</code> to lower
case using the rules of the given <code>Locale</code>. Case mapping is based
on the Unicode Standard version specified by the <a href="../../java/lang/Character.html" title="class in java.lang"><code>Character</code></a>
class. Since case mappings are not always 1:1 char mappings, the resulting
<code>String</code> may be a different length than the original <code>String</code>.
<p>
Examples of lowercase mappings are in the following table:
<table border="1" summary="Lowercase mapping examples showing language code of locale, upper case, lower case, and description">
<tr>
<th>Language Code of Locale</th>
<th>Upper Case</th>
<th>Lower Case</th>
<th>Description</th>
</tr>
<tr>
<td>tr (Turkish)</td>
<td>&#92;u0130</td>
<td>&#92;u0069</td>
<td>capital letter I with dot above -&gt; small letter i</td>
</tr>
<tr>
<td>tr (Turkish)</td>
<td>&#92;u0049</td>
<td>&#92;u0131</td>
<td>capital letter I -&gt; small letter dotless i </td>
</tr>
<tr>
<td>(all)</td>
<td>French Fries</td>
<td>french fries</td>
<td>lowercased all chars in String</td>
</tr>
<tr>
<td>(all)</td>
<td><img src="doc-files/capiota.gif" alt="capiota"><img src="doc-files/capchi.gif" alt="capchi">
<img src="doc-files/captheta.gif" alt="captheta"><img src="doc-files/capupsil.gif" alt="capupsil">
<img src="doc-files/capsigma.gif" alt="capsigma"></td>
<td><img src="doc-files/iota.gif" alt="iota"><img src="doc-files/chi.gif" alt="chi">
<img src="doc-files/theta.gif" alt="theta"><img src="doc-files/upsilon.gif" alt="upsilon">
<img src="doc-files/sigma1.gif" alt="sigma"></td>
<td>lowercased all chars in String</td>
</tr>
</table></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>locale</code> - use the case transformation rules for this locale</dd>
<dt><span class="strong">Returns:</span></dt><dd>the <code>String</code>, converted to lowercase.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.1</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../java/lang/String.html#toLowerCase()"><code>toLowerCase()</code></a>,
<a href="../../java/lang/String.html#toUpperCase()"><code>toUpperCase()</code></a>,
<a href="../../java/lang/String.html#toUpperCase(java.util.Locale)"><code>toUpperCase(Locale)</code></a></dd></dl>
</li>
</ul>
<a name="toLowerCase()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toLowerCase</h4>
<pre>public&nbsp;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;toLowerCase()</pre>
<div class="block">Converts all of the characters in this <code>String</code> to lower
case using the rules of the default locale. This is equivalent to calling
<code>toLowerCase(Locale.getDefault())</code>.
<p>
<b>Note:</b> 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, <code>"TITLE".toLowerCase()</code> in a Turkish locale
returns <code>"t\u0131tle"</code>, where '\u0131' is the
LATIN SMALL LETTER DOTLESS I character.
To obtain correct results for locale insensitive strings, use
<code>toLowerCase(Locale.ENGLISH)</code>.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the <code>String</code>, converted to lowercase.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../java/lang/String.html#toLowerCase(java.util.Locale)"><code>toLowerCase(Locale)</code></a></dd></dl>
</li>
</ul>
<a name="toUpperCase(java.util.Locale)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toUpperCase</h4>
<pre>public&nbsp;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;toUpperCase(<a href="../../java/util/Locale.html" title="class in java.util">Locale</a>&nbsp;locale)</pre>
<div class="block">Converts all of the characters in this <code>String</code> to upper
case using the rules of the given <code>Locale</code>. Case mapping is based
on the Unicode Standard version specified by the <a href="../../java/lang/Character.html" title="class in java.lang"><code>Character</code></a>
class. Since case mappings are not always 1:1 char mappings, the resulting
<code>String</code> may be a different length than the original <code>String</code>.
<p>
Examples of locale-sensitive and 1:M case mappings are in the following table.
<p>
<table border="1" summary="Examples of locale-sensitive and 1:M case mappings. Shows Language code of locale, lower case, upper case, and description.">
<tr>
<th>Language Code of Locale</th>
<th>Lower Case</th>
<th>Upper Case</th>
<th>Description</th>
</tr>
<tr>
<td>tr (Turkish)</td>
<td>&#92;u0069</td>
<td>&#92;u0130</td>
<td>small letter i -&gt; capital letter I with dot above</td>
</tr>
<tr>
<td>tr (Turkish)</td>
<td>&#92;u0131</td>
<td>&#92;u0049</td>
<td>small letter dotless i -&gt; capital letter I</td>
</tr>
<tr>
<td>(all)</td>
<td>&#92;u00df</td>
<td>&#92;u0053 &#92;u0053</td>
<td>small letter sharp s -&gt; two letters: SS</td>
</tr>
<tr>
<td>(all)</td>
<td>Fahrvergn&uuml;gen</td>
<td>FAHRVERGN&Uuml;GEN</td>
<td></td>
</tr>
</table></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>locale</code> - use the case transformation rules for this locale</dd>
<dt><span class="strong">Returns:</span></dt><dd>the <code>String</code>, converted to uppercase.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.1</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../java/lang/String.html#toUpperCase()"><code>toUpperCase()</code></a>,
<a href="../../java/lang/String.html#toLowerCase()"><code>toLowerCase()</code></a>,
<a href="../../java/lang/String.html#toLowerCase(java.util.Locale)"><code>toLowerCase(Locale)</code></a></dd></dl>
</li>
</ul>
<a name="toUpperCase()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toUpperCase</h4>
<pre>public&nbsp;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;toUpperCase()</pre>
<div class="block">Converts all of the characters in this <code>String</code> to upper
case using the rules of the default locale. This method is equivalent to
<code>toUpperCase(Locale.getDefault())</code>.
<p>
<b>Note:</b> 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, <code>"title".toUpperCase()</code> in a Turkish locale
returns <code>"T\u0130TLE"</code>, where '\u0130' is the
LATIN CAPITAL LETTER I WITH DOT ABOVE character.
To obtain correct results for locale insensitive strings, use
<code>toUpperCase(Locale.ENGLISH)</code>.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the <code>String</code>, converted to uppercase.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../java/lang/String.html#toUpperCase(java.util.Locale)"><code>toUpperCase(Locale)</code></a></dd></dl>
</li>
</ul>
<a name="trim()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>trim</h4>
<pre>public&nbsp;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;trim()</pre>
<div class="block">Returns a copy of the string, with leading and trailing whitespace
omitted.
<p>
If this <code>String</code> object represents an empty character
sequence, or the first and last characters of character sequence
represented by this <code>String</code> object both have codes
greater than <code>'&#92;u0020'</code> (the space character), then a
reference to this <code>String</code> object is returned.
<p>
Otherwise, if there is no character with a code greater than
<code>'&#92;u0020'</code> in the string, then a new
<code>String</code> object representing an empty string is created
and returned.
<p>
Otherwise, let <i>k</i> be the index of the first character in the
string whose code is greater than <code>'&#92;u0020'</code>, and let
<i>m</i> be the index of the last character in the string whose code
is greater than <code>'&#92;u0020'</code>. A new <code>String</code>
object is created, representing the substring of this string that
begins with the character at index <i>k</i> and ends with the
character at index <i>m</i>-that is, the result of
<code>this.substring(<i>k</i>,&nbsp;<i>m</i>+1)</code>.
<p>
This method may be used to trim whitespace (as defined above) from
the beginning and end of a string.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A copy of this string with leading and trailing white
space removed, or this string if it has no leading or
trailing white space.</dd></dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;toString()</pre>
<div class="block">This object (which is already a string!) is itself returned.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../java/lang/CharSequence.html#toString()">toString</a></code>&nbsp;in interface&nbsp;<code><a href="../../java/lang/CharSequence.html" title="interface in java.lang">CharSequence</a></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../java/lang/Object.html#toString()">toString</a></code>&nbsp;in class&nbsp;<code><a href="../../java/lang/Object.html" title="class in java.lang">Object</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the string itself.</dd></dl>
</li>
</ul>
<a name="toCharArray()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toCharArray</h4>
<pre>public&nbsp;char[]&nbsp;toCharArray()</pre>
<div class="block">Converts this string to a new character array.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a newly allocated character array whose length is the length
of this string and whose contents are initialized to contain
the character sequence represented by this string.</dd></dl>
</li>
</ul>
<a name="format(java.lang.String, java.lang.Object...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>format</h4>
<pre>public static&nbsp;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;format(<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;format,
<a href="../../java/lang/Object.html" title="class in java.lang">Object</a>...&nbsp;args)</pre>
<div class="block">Returns a formatted string using the specified format string and
arguments.
<p> The locale always used is the one returned by <a href="../../java/util/Locale.html#getDefault()"><code>Locale.getDefault()</code></a>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>format</code> - A <a href="../util/Formatter.html#syntax">format string</a></dd><dd><code>args</code> - 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
<cite>The Java&trade; Virtual Machine Specification</cite>.
The behaviour on a
<tt>null</tt> argument depends on the <a
href="../util/Formatter.html#syntax">conversion</a>.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A formatted string</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>IllegalFormatException</code> - 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 <a
href="../util/Formatter.html#detail">Details</a> section of the
formatter class specification.</dd>
<dd><code><a href="../../java/lang/NullPointerException.html" title="class in java.lang">NullPointerException</a></code> - If the <tt>format</tt> is <tt>null</tt></dd><dt><span class="strong">Since:</span></dt>
<dd>1.5</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../java/util/Formatter.html" title="class in java.util"><code>Formatter</code></a></dd></dl>
</li>
</ul>
<a name="format(java.util.Locale, java.lang.String, java.lang.Object...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>format</h4>
<pre>public static&nbsp;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;format(<a href="../../java/util/Locale.html" title="class in java.util">Locale</a>&nbsp;l,
<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;format,
<a href="../../java/lang/Object.html" title="class in java.lang">Object</a>...&nbsp;args)</pre>
<div class="block">Returns a formatted string using the specified locale, format string,
and arguments.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>l</code> - The <a href="../../java/util/Locale.html" title="class in java.util">locale</a> to apply during
formatting. If <tt>l</tt> is <tt>null</tt> then no localization
is applied.</dd><dd><code>format</code> - A <a href="../util/Formatter.html#syntax">format string</a></dd><dd><code>args</code> - 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
<cite>The Java&trade; Virtual Machine Specification</cite>.
The behaviour on a
<tt>null</tt> argument depends on the <a
href="../util/Formatter.html#syntax">conversion</a>.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A formatted string</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>IllegalFormatException</code> - 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 <a
href="../util/Formatter.html#detail">Details</a> section of the
formatter class specification</dd>
<dd><code><a href="../../java/lang/NullPointerException.html" title="class in java.lang">NullPointerException</a></code> - If the <tt>format</tt> is <tt>null</tt></dd><dt><span class="strong">Since:</span></dt>
<dd>1.5</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../java/util/Formatter.html" title="class in java.util"><code>Formatter</code></a></dd></dl>
</li>
</ul>
<a name="valueOf(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueOf</h4>
<pre>public static&nbsp;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;valueOf(<a href="../../java/lang/Object.html" title="class in java.lang">Object</a>&nbsp;obj)</pre>
<div class="block">Returns the string representation of the <code>Object</code> argument.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>obj</code> - an <code>Object</code>.</dd>
<dt><span class="strong">Returns:</span></dt><dd>if the argument is <code>null</code>, then a string equal to
<code>"null"</code>; otherwise, the value of
<code>obj.toString()</code> is returned.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../java/lang/Object.html#toString()"><code>Object.toString()</code></a></dd></dl>
</li>
</ul>
<a name="valueOf(char[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueOf</h4>
<pre>public static&nbsp;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;valueOf(char[]&nbsp;data)</pre>
<div class="block">Returns the string representation of the <code>char</code> array
argument. The contents of the character array are copied; subsequent
modification of the character array does not affect the newly
created string.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - a <code>char</code> array.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a newly allocated string representing the same sequence of
characters contained in the character array argument.</dd></dl>
</li>
</ul>
<a name="valueOf(char[], int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueOf</h4>
<pre>public static&nbsp;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;valueOf(char[]&nbsp;data,
int&nbsp;offset,
int&nbsp;count)</pre>
<div class="block">Returns the string representation of a specific subarray of the
<code>char</code> array argument.
<p>
The <code>offset</code> argument is the index of the first
character of the subarray. The <code>count</code> 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.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - the character array.</dd><dd><code>offset</code> - the initial offset into the value of the
<code>String</code>.</dd><dd><code>count</code> - the length of the value of the <code>String</code>.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a string representing the sequence of characters contained
in the subarray of the character array argument.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../java/lang/IndexOutOfBoundsException.html" title="class in java.lang">IndexOutOfBoundsException</a></code> - if <code>offset</code> is
negative, or <code>count</code> is negative, or
<code>offset+count</code> is larger than
<code>data.length</code>.</dd></dl>
</li>
</ul>
<a name="copyValueOf(char[], int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copyValueOf</h4>
<pre>public static&nbsp;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;copyValueOf(char[]&nbsp;data,
int&nbsp;offset,
int&nbsp;count)</pre>
<div class="block">Returns a String that represents the character sequence in the
array specified.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - the character array.</dd><dd><code>offset</code> - initial offset of the subarray.</dd><dd><code>count</code> - length of the subarray.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a <code>String</code> that contains the characters of the
specified subarray of the character array.</dd></dl>
</li>
</ul>
<a name="copyValueOf(char[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copyValueOf</h4>
<pre>public static&nbsp;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;copyValueOf(char[]&nbsp;data)</pre>
<div class="block">Returns a String that represents the character sequence in the
array specified.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - the character array.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a <code>String</code> that contains the characters of the
character array.</dd></dl>
</li>
</ul>
<a name="valueOf(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueOf</h4>
<pre>public static&nbsp;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;valueOf(boolean&nbsp;b)</pre>
<div class="block">Returns the string representation of the <code>boolean</code> argument.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>b</code> - a <code>boolean</code>.</dd>
<dt><span class="strong">Returns:</span></dt><dd>if the argument is <code>true</code>, a string equal to
<code>"true"</code> is returned; otherwise, a string equal to
<code>"false"</code> is returned.</dd></dl>
</li>
</ul>
<a name="valueOf(char)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueOf</h4>
<pre>public static&nbsp;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;valueOf(char&nbsp;c)</pre>
<div class="block">Returns the string representation of the <code>char</code>
argument.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>c</code> - a <code>char</code>.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a string of length <code>1</code> containing
as its single character the argument <code>c</code>.</dd></dl>
</li>
</ul>
<a name="valueOf(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueOf</h4>
<pre>public static&nbsp;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;valueOf(int&nbsp;i)</pre>
<div class="block">Returns the string representation of the <code>int</code> argument.
<p>
The representation is exactly the one returned by the
<code>Integer.toString</code> method of one argument.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>i</code> - an <code>int</code>.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a string representation of the <code>int</code> argument.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../java/lang/Integer.html#toString(int, int)"><code>Integer.toString(int, int)</code></a></dd></dl>
</li>
</ul>
<a name="valueOf(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueOf</h4>
<pre>public static&nbsp;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;valueOf(long&nbsp;l)</pre>
<div class="block">Returns the string representation of the <code>long</code> argument.
<p>
The representation is exactly the one returned by the
<code>Long.toString</code> method of one argument.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>l</code> - a <code>long</code>.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a string representation of the <code>long</code> argument.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../java/lang/Long.html#toString(long)"><code>Long.toString(long)</code></a></dd></dl>
</li>
</ul>
<a name="valueOf(float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueOf</h4>
<pre>public static&nbsp;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;valueOf(float&nbsp;f)</pre>
<div class="block">Returns the string representation of the <code>float</code> argument.
<p>
The representation is exactly the one returned by the
<code>Float.toString</code> method of one argument.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>f</code> - a <code>float</code>.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a string representation of the <code>float</code> argument.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../java/lang/Float.html#toString(float)"><code>Float.toString(float)</code></a></dd></dl>
</li>
</ul>
<a name="valueOf(double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueOf</h4>
<pre>public static&nbsp;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;valueOf(double&nbsp;d)</pre>
<div class="block">Returns the string representation of the <code>double</code> argument.
<p>
The representation is exactly the one returned by the
<code>Double.toString</code> method of one argument.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>d</code> - a <code>double</code>.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a string representation of the <code>double</code> argument.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../java/lang/Double.html#toString(double)"><code>Double.toString(double)</code></a></dd></dl>
</li>
</ul>
<a name="intern()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>intern</h4>
<pre>public&nbsp;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;intern()</pre>
<div class="block">Returns a canonical representation for the string object.
<p>
A pool of strings, initially empty, is maintained privately by the
class <code>String</code>.
<p>
When the intern method is invoked, if the pool already contains a
string equal to this <code>String</code> object as determined by
the <a href="../../java/lang/String.html#equals(java.lang.Object)"><code>equals(Object)</code></a> method, then the string from the pool is
returned. Otherwise, this <code>String</code> object is added to the
pool and a reference to this <code>String</code> object is returned.
<p>
It follows that for any two strings <code>s</code> and <code>t</code>,
<code>s.intern()&nbsp;==&nbsp;t.intern()</code> is <code>true</code>
if and only if <code>s.equals(t)</code> is <code>true</code>.
<p>
All literal strings and string-valued constant expressions are
interned. String literals are defined in section 3.10.5 of the
<cite>The Java&trade; Language Specification</cite>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a string that has the same contents as this string, but is
guaranteed to be from a pool of unique strings.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/String.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><strong>Java&trade;&nbsp;Platform<br>Standard&nbsp;Ed.&nbsp;7</strong></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../java/lang/StrictMath.html" title="class in java.lang"><span class="strong">Prev Class</span></a></li>
<li><a href="../../java/lang/StringBuffer.html" title="class in java.lang"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?java/lang/String.html" target="_top">Frames</a></li>
<li><a href="String.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><font size="-1"> <a href="http://bugreport.sun.com/bugreport/">Submit a bug or feature</a> <br>For further API reference and developer documentation, see <a href="http://download.oracle.com/javase/7/docs/index.html" target="_blank">Java SE Documentation</a>. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.<br> <a href="../../../legal/cpyr.html">Copyright</a> &#x00a9; 1993, 2011, Oracle and/or its affiliates. All rights reserved. </font></small></p>
<!-- Start SiteCatalyst code -->
<script language="JavaScript" src="http://www.oracle.com/ocom/groups/systemobject/@mktg_admin/documents/systemobject/s_code_download.js"></script>
<script language="JavaScript" src="http://www.oracle.com/ocom/groups/systemobject/@mktg_admin/documents/systemobject/s_code.js"></script>
<!-- ********** DO NOT ALTER ANYTHING BELOW THIS LINE ! *********** -->
<!-- Below code will send the info to Omniture server -->
<script language="javascript">var s_code=s.t();if(s_code)document.write(s_code)</script>
<!-- End SiteCatalyst code -->
<noscript>
<p>Scripting on this page tracks web page traffic, but does not change the content in any way.</p>
</noscript>
</body>
</html>