blob: 57a15ddfcbb4355c7290ec3802013bc315e34901 [file] [log] [blame]
<html>
<head>
<title>String</title>
<link href="book.css" rel="stylesheet" type="text/css"/>
<meta content="DocBook XSL Stylesheets V1.75.1" name="generator"/>
<link rel="home" href="index.html" title="Xpand Documentation"/>
<link rel="up" href="builtin_api.html" title="Built-in types API documentation"/>
<link rel="prev" href="builtin_api.html" title="Built-in types API documentation"/>
<link rel="next" href="Integer.html.html" title="Integer"/>
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<h1 xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0">String</h1>
<div class="section" title="String">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both">
<a name="String.html"/>
<code class="classname">String</code>
</h2>
</div>
</div>
</div>
<p>
Supertype:
<a class="link" href="builtin_api.html#Object.html" title="Object">
<code class="classname">Object</code>
</a>
</p>
<p>
</p>
<div class="table">
<a name="String_Properties"/>
<p class="title">
<b>Table 3. Properties</b>
</p>
<div class="table-contents">
<table summary="Properties" cellspacing="0" cellpadding="10" style="border-collapse: collapse;border-top: 0.5pt solid ; border-bottom: 0.5pt solid ; border-left: 0.5pt solid ; border-right: 0.5pt solid ; ">
<colgroup>
<col align="left"/>
<col align="left"/>
<col align="left"/>
</colgroup>
<thead>
<tr>
<th style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">Type</th>
<th style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">Name</th>
<th style="border-bottom: 2 solid #000000; " align="left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="border-right: 2 solid #000000; " align="left">
<a class="link" href="Integer.html.html" title="Integer">
<code class="classname">Integer</code>
</a>
</td>
<td style="border-right: 2 solid #000000; " align="left">
<code class="methodname">length</code>
</td>
<td style="" align="left">
the length of this string
</td>
</tr>
</tbody>
</table>
</div>
</div>
<p>
<br class="table-break"/>
</p>
<p>
</p>
<div class="table">
<a name="String_Operations"/>
<p class="title">
<b>Table 4. Operations</b>
</p>
<div class="table-contents">
<table summary="Operations" cellspacing="0" cellpadding="10" style="border-collapse: collapse;border-top: 0.5pt solid ; border-bottom: 0.5pt solid ; border-left: 0.5pt solid ; border-right: 0.5pt solid ; ">
<colgroup>
<col align="left"/>
<col align="left"/>
<col align="left"/>
</colgroup>
<thead>
<tr>
<th style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">Return type</th>
<th style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">Name</th>
<th style="border-bottom: 2 solid #000000; " align="left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<a class="link" href="String.html.html" title="String">
<code class="classname">String</code>
</a>
</td>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<code class="methodname">toLowerCase</code>
()
</td>
<td style="border-bottom: 2 solid #000000; " align="left">
Converts all of the characters in this String to lower case using the rules of the default locale (from Java)
</td>
</tr>
<tr>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<a class="link" href="String.html.html" title="String">
<code class="classname">String</code>
</a>
</td>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<code class="methodname">+</code>
(<a class="link" href="builtin_api.html#Object.html" title="Object">
<code class="classname">Object</code>
</a>)
</td>
<td style="border-bottom: 2 solid #000000; " align="left">
concatenates two strings
</td>
</tr>
<tr>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<a class="link" href="List.html.html" title="List">
<code class="classname">List</code>
</a>
</td>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<code class="methodname">toCharList</code>
()
</td>
<td style="border-bottom: 2 solid #000000; " align="left">
splits this String into a List[String] containing Strings of length 1
</td>
</tr>
<tr>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<a class="link" href="String.html.html" title="String">
<code class="classname">String</code>
</a>
</td>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<code class="methodname">toFirstUpper</code>
()
</td>
<td style="border-bottom: 2 solid #000000; " align="left">
Converts the first character in this String to upper case using the rules of the default locale (from Java)
</td>
</tr>
<tr>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<a class="link" href="String.html.html" title="String">
<code class="classname">String</code>
</a>
</td>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<code class="methodname">subString</code>
(<a class="link" href="Integer.html.html" title="Integer">
<code class="classname">Integer</code>
</a>, <a class="link" href="Integer.html.html" title="Integer">
<code class="classname">Integer</code>
</a>)
</td>
<td style="border-bottom: 2 solid #000000; " align="left">
Returns a new string that is a substring of this string.
</td>
</tr>
<tr>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<a class="link" href="String.html.html" title="String">
<code class="classname">String</code>
</a>
</td>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<code class="methodname">trim</code>
()
</td>
<td style="border-bottom: 2 solid #000000; " align="left">
Returns a copy of the string, with leading and trailing whitespace omitted. (from Java 1.4)
</td>
</tr>
<tr>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<a class="link" href="String.html.html" title="String">
<code class="classname">String</code>
</a>
</td>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<code class="methodname">toFirstLower</code>
()
</td>
<td style="border-bottom: 2 solid #000000; " align="left">
Converts the first character in this String to lower case using the rules of the default locale (from Java)
</td>
</tr>
<tr>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<a class="link" href="String.html.html" title="String">
<code class="classname">String</code>
</a>
</td>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<code class="methodname">toUpperCase</code>
()
</td>
<td style="border-bottom: 2 solid #000000; " align="left">
Converts all of the characters in this String to upper case using the rules of the default locale (from Java)
</td>
</tr>
<tr>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<a class="link" href="List.html.html" title="List">
<code class="classname">List</code>
</a>
</td>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<code class="methodname">split</code>
(<a class="link" href="String.html.html" title="String">
<code class="classname">String</code>
</a>)
</td>
<td style="border-bottom: 2 solid #000000; " align="left">
Splits this string around matches of the given regular expression (from Java 1.4)
</td>
</tr>
<tr>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<a class="link" href="Boolean.html.html" title="Boolean">
<code class="classname">Boolean</code>
</a>
</td>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<code class="methodname">startsWith</code>
(<a class="link" href="String.html.html" title="String">
<code class="classname">String</code>
</a>)
</td>
<td style="border-bottom: 2 solid #000000; " align="left">
Tests if this string starts with the specified prefix.
</td>
</tr>
<tr>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<a class="link" href="Boolean.html.html" title="Boolean">
<code class="classname">Boolean</code>
</a>
</td>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<code class="methodname">matches</code>
(<a class="link" href="String.html.html" title="String">
<code class="classname">String</code>
</a>)
</td>
<td style="border-bottom: 2 solid #000000; " align="left">
Tells whether or not this string matches the given regular expression. (from Java 1.4)
</td>
</tr>
<tr>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<a class="link" href="Integer.html.html" title="Integer">
<code class="classname">Integer</code>
</a>
</td>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<code class="methodname">asInteger</code>
()
</td>
<td style="border-bottom: 2 solid #000000; " align="left">
Returns an Integer object holding the value of the specified String (from Java 1.5)
</td>
</tr>
<tr>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<a class="link" href="Boolean.html.html" title="Boolean">
<code class="classname">Boolean</code>
</a>
</td>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<code class="methodname">contains</code>
(<a class="link" href="String.html.html" title="String">
<code class="classname">String</code>
</a>)
</td>
<td style="border-bottom: 2 solid #000000; " align="left">
Tests if this string contains substring.
</td>
</tr>
<tr>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<a class="link" href="Boolean.html.html" title="Boolean">
<code class="classname">Boolean</code>
</a>
</td>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<code class="methodname">endsWith</code>
(<a class="link" href="String.html.html" title="String">
<code class="classname">String</code>
</a>)
</td>
<td style="border-bottom: 2 solid #000000; " align="left">
Tests if this string ends with the specified prefix.
</td>
</tr>
<tr>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<a class="link" href="String.html.html" title="String">
<code class="classname">String</code>
</a>
</td>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<code class="methodname">replaceFirst</code>
(<a class="link" href="String.html.html" title="String">
<code class="classname">String</code>
</a>, <a class="link" href="String.html.html" title="String">
<code class="classname">String</code>
</a>)
</td>
<td style="border-bottom: 2 solid #000000; " align="left">
Replaces the first substring of this string that matches the given regular expression with the given replacement.
</td>
</tr>
<tr>
<td style="border-right: 2 solid #000000; " align="left">
<a class="link" href="String.html.html" title="String">
<code class="classname">String</code>
</a>
</td>
<td style="border-right: 2 solid #000000; " align="left">
<code class="methodname">replaceAll</code>
(<a class="link" href="String.html.html" title="String">
<code class="classname">String</code>
</a>, <a class="link" href="String.html.html" title="String">
<code class="classname">String</code>
</a>)
</td>
<td style="" align="left">
Replaces each substring of this string that matches the given regular expression with the given replacement.
</td>
</tr>
</tbody>
</table>
</div>
</div>
<p>
<br class="table-break"/>
</p>
</div>
</body>
</html>