summaryrefslogtreecommitdiff
path: root/doc/org/unitConverter/math/ConditionalExistenceCollections.html
blob: 276414654c840198d927211e8798fc17ba302c55 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
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&nbsp;Class</li>
<li><a href="../../../org/unitConverter/math/DecimalComparison.html" title="class in org.unitConverter.math"><span class="typeNameLink">Next&nbsp;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&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;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>Field&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>Field&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">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">&nbsp;</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>&nbsp;</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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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 &lt;E&gt;&nbsp;java.util.Collection&lt;E&gt;</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&lt;E&gt;&nbsp;collection,
                              java.util.function.Predicate&lt;E&gt;&nbsp;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 &lt;E&gt;&nbsp;java.util.Iterator&lt;E&gt;</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&lt;E&gt;&nbsp;iterator,
                            java.util.function.Predicate&lt;E&gt;&nbsp;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 &lt;K,V&gt;&nbsp;java.util.Map&lt;K,V&gt;</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&lt;K,V&gt;&nbsp;map,
                       java.util.function.Predicate&lt;java.util.Map.Entry&lt;K,V&gt;&gt;&nbsp;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 &lt;E&gt;&nbsp;java.util.Set&lt;E&gt;</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&lt;E&gt;&nbsp;set,
                       java.util.function.Predicate&lt;E&gt;&nbsp;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&nbsp;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&nbsp;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&nbsp;&lt;E&gt;&nbsp;java.util.Collection&lt;E&gt;&nbsp;conditionalExistenceCollection(java.util.Collection&lt;E&gt;&nbsp;collection,
                                                                               java.util.function.Predicate&lt;E&gt;&nbsp;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&nbsp;&lt;E&gt;&nbsp;java.util.Iterator&lt;E&gt;&nbsp;conditionalExistenceIterator(java.util.Iterator&lt;E&gt;&nbsp;iterator,
                                                                           java.util.function.Predicate&lt;E&gt;&nbsp;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&nbsp;&lt;K,V&gt;&nbsp;java.util.Map&lt;K,V&gt;&nbsp;conditionalExistenceMap(java.util.Map&lt;K,V&gt;&nbsp;map,
                                                                     java.util.function.Predicate&lt;java.util.Map.Entry&lt;K,V&gt;&gt;&nbsp;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&nbsp;&lt;E&gt;&nbsp;java.util.Set&lt;E&gt;&nbsp;conditionalExistenceSet(java.util.Set&lt;E&gt;&nbsp;set,
                                                                 java.util.function.Predicate&lt;E&gt;&nbsp;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&nbsp;Class</li>
<li><a href="../../../org/unitConverter/math/DecimalComparison.html" title="class in org.unitConverter.math"><span class="typeNameLink">Next&nbsp;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&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;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>Field&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>Field&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 ======= -->
</body>
</html>