blob: 3c3849938a24cac7ea4cdf5dd524086f5c4727e0 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (14.0.2) on Thu Aug 20 21:25:36 CDT 2020 -->
<title>org.eclipse.collections.api.set (Eclipse Collections - 10.4.0)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2020-08-20">
<meta name="description" content="declaration: package: org.eclipse.collections.api.set">
<meta name="generator" content="javadoc/PackageWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../script-dir/jquery-3.4.1.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.js"></script>
</head>
<body class="package-declaration">
<script type="text/javascript">var pathtoroot = "../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flexBox">
<header role="banner" class="flexHeader">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<div class="navListSearch"><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="skipNav"><a id="skip.navbar.top">
<!-- -->
</a></div>
</nav>
</header>
<div class="flexContent">
<main role="main">
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.eclipse.collections.api.set</h1>
</div>
<div class="contentContainer">
<section class="packageDescription"><a id="package.description">
<!-- -->
</a>
<div class="block">This package contains interfaces for set API which enhance the performance and functionality of <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Set</code></a>.
<p>
This package contains 6 interfaces:
<ul>
<li>
<a href="FixedSizeSet.html" title="interface in org.eclipse.collections.api.set"><code>FixedSizeSet</code></a> - a set that may be mutated, but cannot grow or shrink in size.
</li>
<li>
<a href="ImmutableSet.html" title="interface in org.eclipse.collections.api.set"><code>ImmutableSet</code></a> - the non-modifiable equivalent interface to <a href="MutableSet.html" title="interface in org.eclipse.collections.api.set"><code>MutableSet</code></a>.
</li>
<li>
<a href="MutableSet.html" title="interface in org.eclipse.collections.api.set"><code>MutableSet</code></a> - an implementation of a JCF Set which provides internal iterator methods matching the Smalltalk Collection protocol.
</li>
<li>
<a href="Pool.html" title="interface in org.eclipse.collections.api.set"><code>Pool</code></a> - locates an object in the pool which is equal to <code>key</code>.
</li>
<li>
<a href="SetIterable.html" title="interface in org.eclipse.collections.api.set"><code>SetIterable</code></a> - a read-only Set API, with the minor exception inherited from <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Iterable</code></a> (iterable.iterator().remove()).
</li>
<li>
<a href="UnsortedSetIterable.html" title="interface in org.eclipse.collections.api.set"><code>UnsortedSetIterable</code></a> - an iterable whose items are unique.
</li>
</ul></div>
</section>
<section class="summary">
<ul class="blockList">
<li class="blockList">
<div class="typeSummary">
<table>
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<thead>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="FixedSizeSet.html" title="interface in org.eclipse.collections.api.set">FixedSizeSet</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">A FixedSizeSet is a set that may be mutated, but cannot grow or shrink in size.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ImmutableSet.html" title="interface in org.eclipse.collections.api.set">ImmutableSet</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">ImmutableSet is the non-modifiable equivalent interface to <a href="MutableSet.html" title="interface in org.eclipse.collections.api.set"><code>MutableSet</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ImmutableSetIterable.html" title="interface in org.eclipse.collections.api.set">ImmutableSetIterable</a>&lt;T&gt;</th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MultiReaderSet.html" title="interface in org.eclipse.collections.api.set">MultiReaderSet</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">A MultiReaderSet provides thread-safe iteration for a set through methods <code>withReadLockAndDelegate()</code> and <code>withWriteLockAndDelegate()</code>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MutableSet.html" title="interface in org.eclipse.collections.api.set">MutableSet</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">A MutableSet is an extension java.util.Set which provides methods matching the Smalltalk Collection protocol.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MutableSetIterable.html" title="interface in org.eclipse.collections.api.set">MutableSetIterable</a>&lt;T&gt;</th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ParallelSetIterable.html" title="interface in org.eclipse.collections.api.set">ParallelSetIterable</a>&lt;T&gt;</th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ParallelUnsortedSetIterable.html" title="interface in org.eclipse.collections.api.set">ParallelUnsortedSetIterable</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">A ParallelIterable is RichIterable which will defer evaluation for certain methods like select, reject, collect, etc.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Pool.html" title="interface in org.eclipse.collections.api.set">Pool</a>&lt;V&gt;</th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SetIterable.html" title="interface in org.eclipse.collections.api.set">SetIterable</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">A Read-only Set api, with the minor exception inherited from java.lang.Iterable (iterable.iterator().remove()).</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="UnsortedSetIterable.html" title="interface in org.eclipse.collections.api.set">UnsortedSetIterable</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">An iterable whose items are unique.</div>
</td>
</tr>
</tbody>
</table>
</div>
</li>
</ul>
</section>
</div>
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2004&#x2013;2020. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>