blob: 3959f44519b99e4301364cc931b8f77fe9cef0bc [file] [log] [blame]
<html>
<head>
<title>Collection</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="Real.html.html" title="Real"/>
<link rel="next" href="List.html.html" title="List"/>
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<h1 xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0">Collection</h1>
<div class="section" title="Collection">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both">
<a name="Collection.html"/>
<code class="classname">Collection</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="Collection_Properties"/>
<p class="title">
<b>Table 8. 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; 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">isEmpty</code>
</td>
<td style="border-bottom: 2 solid #000000; " align="left">
returns true if this Collection is empty
</td>
</tr>
<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">size</code>
</td>
<td style="" align="left">
returns the size of this Collection
</td>
</tr>
</tbody>
</table>
</div>
</div>
<p>
<br class="table-break"/>
</p>
<p>
</p>
<div class="table">
<a name="Collection_Operations"/>
<p class="title">
<b>Table 9. 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="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="builtin_api.html#Object.html" title="Object">
<code class="classname">Object</code>
</a>)
</td>
<td style="border-bottom: 2 solid #000000; " align="left">
returns true if this collection contains the specified object. otherwise false. returns this Collection.
</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">toList</code>
()
</td>
<td style="border-bottom: 2 solid #000000; " align="left">
converts this collection to List
</td>
</tr>
<tr>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<a class="link" href="Set.html.html" title="Set">
<code class="classname">Set</code>
</a>
</td>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<code class="methodname">toSet</code>
()
</td>
<td style="border-bottom: 2 solid #000000; " align="left">
converts this collection to Set
</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">flatten</code>
()
</td>
<td style="border-bottom: 2 solid #000000; " align="left">
returns a flattened List.
</td>
</tr>
<tr>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<a class="link" href="Set.html.html" title="Set">
<code class="classname">Set</code>
</a>
</td>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<code class="methodname">intersect</code>
(<a class="link" href="Collection.html.html" title="Collection">
<code class="classname">Collection</code>
</a>)
</td>
<td style="border-bottom: 2 solid #000000; " align="left">
returns a new Set, containing only the elements contained in this and the specified Collection
</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">toString</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">
concatenates each contained element (using toString()), separated by the specified String.
</td>
</tr>
<tr>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<a class="link" href="Collection.html.html" title="Collection">
<code class="classname">Collection</code>
</a>
</td>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<code class="methodname">removeAll</code>
(<a class="link" href="Collection.html.html" title="Collection">
<code class="classname">Collection</code>
</a>)
</td>
<td style="border-bottom: 2 solid #000000; " align="left">
removes all elements contained in the specified collection from this Collection if contained (modifies it!). returns this Collection.
</td>
</tr>
<tr>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<a class="link" href="Collection.html.html" title="Collection">
<code class="classname">Collection</code>
</a>
</td>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<code class="methodname">remove</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">
removes the specified element from this Collection if contained (modifies it!). returns this Collection.
</td>
</tr>
<tr>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<a class="link" href="Set.html.html" title="Set">
<code class="classname">Set</code>
</a>
</td>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<code class="methodname">without</code>
(<a class="link" href="Collection.html.html" title="Collection">
<code class="classname">Collection</code>
</a>)
</td>
<td style="border-bottom: 2 solid #000000; " align="left">
returns a new Set, containing all elements from this Collection without the elements from specified Collection
</td>
</tr>
<tr>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<a class="link" href="Collection.html.html" title="Collection">
<code class="classname">Collection</code>
</a>
</td>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<code class="methodname">addAll</code>
(<a class="link" href="Collection.html.html" title="Collection">
<code class="classname">Collection</code>
</a>)
</td>
<td style="border-bottom: 2 solid #000000; " align="left">
adds all elements to the Collection (modifies it!). returns this Collection.
</td>
</tr>
<tr>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<a class="link" href="Collection.html.html" title="Collection">
<code class="classname">Collection</code>
</a>
</td>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<code class="methodname">add</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">
adds an element to the Collection (modifies it!). returns this Collection.
</td>
</tr>
<tr>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<a class="link" href="Set.html.html" title="Set">
<code class="classname">Set</code>
</a>
</td>
<td style="border-right: 2 solid #000000; border-bottom: 2 solid #000000; " align="left">
<code class="methodname">union</code>
(<a class="link" href="Collection.html.html" title="Collection">
<code class="classname">Collection</code>
</a>)
</td>
<td style="border-bottom: 2 solid #000000; " align="left">
returns a new Set, containing all elements from this and the specified Collection
</td>
</tr>
<tr>
<td style="border-right: 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; " align="left">
<code class="methodname">containsAll</code>
(<a class="link" href="Collection.html.html" title="Collection">
<code class="classname">Collection</code>
</a>)
</td>
<td style="" align="left">
returns true if this collection contains each element contained in the specified collection. otherwise false. returns this Collection.
</td>
</tr>
</tbody>
</table>
</div>
</div>
<p>
<br class="table-break"/>
</p>
</div>
</body>
</html>