diff options
| author | Adrien Hopkins <masterofnumbers17@gmail.com> | 2019-12-24 16:16:13 -0500 |
|---|---|---|
| committer | Adrien Hopkins <masterofnumbers17@gmail.com> | 2019-12-24 16:16:13 -0500 |
| commit | 2c146c894972e2c6ab701b3c66dcf242d7be656f (patch) | |
| tree | 8629866fa1cf017c02d61bd288fd336e7d8b7b49 /doc/org/unitConverter/math/ConditionalExistenceCollections.html | |
| parent | e1e7e38482de8cf8f6d4fd8735b6e43ad2a13cb8 (diff) | |
Added Javadoc to the project.
Diffstat (limited to 'doc/org/unitConverter/math/ConditionalExistenceCollections.html')
| -rw-r--r-- | doc/org/unitConverter/math/ConditionalExistenceCollections.html | 397 |
1 files changed, 397 insertions, 0 deletions
diff --git a/doc/org/unitConverter/math/ConditionalExistenceCollections.html b/doc/org/unitConverter/math/ConditionalExistenceCollections.html new file mode 100644 index 0000000..2764146 --- /dev/null +++ b/doc/org/unitConverter/math/ConditionalExistenceCollections.html @@ -0,0 +1,397 @@ +<!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 (1.8.0_232) on Tue Dec 24 16:10:16 EST 2019 --> +<title>ConditionalExistenceCollections</title> +<meta name="date" content="2019-12-24"> +<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ConditionalExistenceCollections"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9,"i2":9,"i3":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<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/ConditionalExistenceCollections.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> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../org/unitConverter/math/DecimalComparison.html" title="class in org.unitConverter.math"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/unitConverter/math/ConditionalExistenceCollections.html" target="_top">Frames</a></li> +<li><a href="ConditionalExistenceCollections.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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">org.unitConverter.math</div> +<h2 title="Class ConditionalExistenceCollections" class="title">Class ConditionalExistenceCollections</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.unitConverter.math.ConditionalExistenceCollections</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <span class="typeNameLabel">ConditionalExistenceCollections</span> +extends java.lang.Object</pre> +<div class="block">Elements in these wrapper collections only exist if they pass a condition. + <p> + All of the collections in this class are "views" of the provided collections. They are mutable if the provided + collections are mutable, they allow null if the provided collections allow null, they will reflect changes in the + provided collection, etc. + <p> + The modification operations will always run the corresponding operations, even if the conditional existence + collection doesn't change. For example, if you have a set that ignores even numbers, add(2) will still add a 2 to the + backing set (but the conditional existence set will say it doesn't exist). + <p> + The returned collections do <i>not</i> pass the hashCode and equals operations through to the backing collections, + but rely on <code>Object</code>'s <code>equals</code> and <code>hashCode</code> methods. This is necessary to preserve the contracts + of these operations in the case that the backing collections are sets or lists. + <p> + Other than that, <i>the only difference between the provided collections and the returned collections are that + elements don't exist if they don't pass the provided condition</i>.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-10-17</dd> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>Adrien Hopkins</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/unitConverter/math/ConditionalExistenceCollections.html#ConditionalExistenceCollections--">ConditionalExistenceCollections</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>static <E> java.util.Collection<E></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/math/ConditionalExistenceCollections.html#conditionalExistenceCollection-java.util.Collection-java.util.function.Predicate-">conditionalExistenceCollection</a></span>(java.util.Collection<E> collection, + java.util.function.Predicate<E> existenceCondition)</code> +<div class="block">Elements in the returned wrapper collection are ignored if they don't pass a condition.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <E> java.util.Iterator<E></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/math/ConditionalExistenceCollections.html#conditionalExistenceIterator-java.util.Iterator-java.util.function.Predicate-">conditionalExistenceIterator</a></span>(java.util.Iterator<E> iterator, + java.util.function.Predicate<E> existenceCondition)</code> +<div class="block">Elements in the returned wrapper iterator are ignored if they don't pass a condition.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static <K,V> java.util.Map<K,V></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/math/ConditionalExistenceCollections.html#conditionalExistenceMap-java.util.Map-java.util.function.Predicate-">conditionalExistenceMap</a></span>(java.util.Map<K,V> map, + java.util.function.Predicate<java.util.Map.Entry<K,V>> entryExistenceCondition)</code> +<div class="block">Mappings in the returned wrapper map are ignored if the corresponding entry doesn't pass a condition</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>static <E> java.util.Set<E></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/math/ConditionalExistenceCollections.html#conditionalExistenceSet-java.util.Set-java.util.function.Predicate-">conditionalExistenceSet</a></span>(java.util.Set<E> set, + java.util.function.Predicate<E> existenceCondition)</code> +<div class="block">Elements in the returned wrapper set are ignored if they don't pass a condition.</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 java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ConditionalExistenceCollections--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ConditionalExistenceCollections</h4> +<pre>public ConditionalExistenceCollections()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="conditionalExistenceCollection-java.util.Collection-java.util.function.Predicate-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>conditionalExistenceCollection</h4> +<pre>public static final <E> java.util.Collection<E> conditionalExistenceCollection(java.util.Collection<E> collection, + java.util.function.Predicate<E> existenceCondition)</pre> +<div class="block">Elements in the returned wrapper collection are ignored if they don't pass a condition.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>E</code> - type of elements in collection</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>collection</code> - collection to wrap</dd> +<dd><code>existenceCondition</code> - elements only exist if this returns true</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>wrapper collection</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-10-17</dd> +</dl> +</li> +</ul> +<a name="conditionalExistenceIterator-java.util.Iterator-java.util.function.Predicate-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>conditionalExistenceIterator</h4> +<pre>public static final <E> java.util.Iterator<E> conditionalExistenceIterator(java.util.Iterator<E> iterator, + java.util.function.Predicate<E> existenceCondition)</pre> +<div class="block">Elements in the returned wrapper iterator are ignored if they don't pass a condition.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>E</code> - type of elements in iterator</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>iterator</code> - iterator to wrap</dd> +<dd><code>existenceCondition</code> - elements only exist if this returns true</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>wrapper iterator</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-10-17</dd> +</dl> +</li> +</ul> +<a name="conditionalExistenceMap-java.util.Map-java.util.function.Predicate-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>conditionalExistenceMap</h4> +<pre>public static final <K,V> java.util.Map<K,V> conditionalExistenceMap(java.util.Map<K,V> map, + java.util.function.Predicate<java.util.Map.Entry<K,V>> entryExistenceCondition)</pre> +<div class="block">Mappings in the returned wrapper map are ignored if the corresponding entry doesn't pass a condition</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>K</code> - type of key in map</dd> +<dd><code>V</code> - type of value in map</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>map</code> - map to wrap</dd> +<dd><code>entryExistenceCondition</code> - mappings only exist if this returns true</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>wrapper map</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-10-17</dd> +</dl> +</li> +</ul> +<a name="conditionalExistenceSet-java.util.Set-java.util.function.Predicate-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>conditionalExistenceSet</h4> +<pre>public static final <E> java.util.Set<E> conditionalExistenceSet(java.util.Set<E> set, + java.util.function.Predicate<E> existenceCondition)</pre> +<div class="block">Elements in the returned wrapper set are ignored if they don't pass a condition.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>E</code> - type of elements in set</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>set</code> - set to wrap</dd> +<dd><code>existenceCondition</code> - elements only exist if this returns true</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>wrapper set</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-10-17</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> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<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/ConditionalExistenceCollections.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> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../org/unitConverter/math/DecimalComparison.html" title="class in org.unitConverter.math"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/unitConverter/math/ConditionalExistenceCollections.html" target="_top">Frames</a></li> +<li><a href="ConditionalExistenceCollections.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> |