-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathVisitor.html
346 lines (346 loc) · 16.6 KB
/
Visitor.html
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
<!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 (version 1.7.0_45) on Mon Dec 15 00:48:02 EST 2014 -->
<title>Visitor</title>
<meta name="date" content="2014-12-15">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Visitor";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="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">
<ul class="navList">
<li><a href="../../fj/function/Strings.html" title="class in fj.function"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../index.html?fj/function/Visitor.html" target="_top">Frames</a></li>
<li><a href="Visitor.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>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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">fj.function</div>
<h2 title="Class Visitor" class="title">Class Visitor</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>fj.function.Visitor</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="strong">Visitor</span>
extends java.lang.Object</pre>
<div class="block">The essence of the visitor design pattern expressed polymorphically.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <A,B> <a href="../../fj/F.html" title="class in fj">F</a><B,<a href="../../fj/F.html" title="class in fj">F</a><A,B>></code></td>
<td class="colLast"><code><strong><a href="../../fj/function/Visitor.html#association(fj.data.List, fj.Equal)">association</a></strong>(<a href="../../fj/data/List.html" title="class in fj.data">List</a><<a href="../../fj/P2.html" title="class in fj">P2</a><A,B>> x,
<a href="../../fj/Equal.html" title="class in fj">Equal</a><A> eq)</code>
<div class="block">Uses an association list to perform a lookup with equality and returns a function that can be applied to a default,
followed by the associated key to return a value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <A,B> <a href="../../fj/F.html" title="class in fj">F</a><<a href="../../fj/P1.html" title="class in fj">P1</a><B>,<a href="../../fj/F.html" title="class in fj">F</a><A,B>></code></td>
<td class="colLast"><code><strong><a href="../../fj/function/Visitor.html#associationLazy(fj.data.List, fj.Equal)">associationLazy</a></strong>(<a href="../../fj/data/List.html" title="class in fj.data">List</a><<a href="../../fj/P2.html" title="class in fj">P2</a><A,B>> x,
<a href="../../fj/Equal.html" title="class in fj">Equal</a><A> eq)</code>
<div class="block">Uses an association list to perform a lookup with equality and returns a function that can be applied to a default,
followed by the associated key to return a value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <X> X</code></td>
<td class="colLast"><code><strong><a href="../../fj/function/Visitor.html#findFirst(fj.data.List, fj.P1)">findFirst</a></strong>(<a href="../../fj/data/List.html" title="class in fj.data">List</a><<a href="../../fj/data/Option.html" title="class in fj.data">Option</a><X>> values,
<a href="../../fj/P1.html" title="class in fj">P1</a><X> def)</code>
<div class="block">Returns the first value available in the given list of optional values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <X> X</code></td>
<td class="colLast"><code><strong><a href="../../fj/function/Visitor.html#nullablefindFirst(fj.data.List, fj.P1)">nullablefindFirst</a></strong>(<a href="../../fj/data/List.html" title="class in fj.data">List</a><X> values,
<a href="../../fj/P1.html" title="class in fj">P1</a><X> def)</code>
<div class="block">Returns the first non-<code>null</code> value in the given list of optional values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <A,B> B</code></td>
<td class="colLast"><code><strong><a href="../../fj/function/Visitor.html#nullableVisitor(fj.data.List, fj.P1, A)">nullableVisitor</a></strong>(<a href="../../fj/data/List.html" title="class in fj.data">List</a><<a href="../../fj/F.html" title="class in fj">F</a><A,B>> visitors,
<a href="../../fj/P1.html" title="class in fj">P1</a><B> def,
A value)</code>
<div class="block">Returns the first non-<code>null</code> value found in the list of visitors after application of the given value,
otherwise returns the given default.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <A,B> B</code></td>
<td class="colLast"><code><strong><a href="../../fj/function/Visitor.html#visitor(fj.data.List, fj.P1, A)">visitor</a></strong>(<a href="../../fj/data/List.html" title="class in fj.data">List</a><<a href="../../fj/F.html" title="class in fj">F</a><A,<a href="../../fj/data/Option.html" title="class in fj.data">Option</a><B>>> visitors,
<a href="../../fj/P1.html" title="class in fj">P1</a><B> def,
A value)</code>
<div class="block">Returns the first value found in the list of visitors after application of the given value, otherwise returns the
given default.</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">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="findFirst(fj.data.List, fj.P1)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findFirst</h4>
<pre>public static <X> X findFirst(<a href="../../fj/data/List.html" title="class in fj.data">List</a><<a href="../../fj/data/Option.html" title="class in fj.data">Option</a><X>> values,
<a href="../../fj/P1.html" title="class in fj">P1</a><X> def)</pre>
<div class="block">Returns the first value available in the given list of optional values. If none is found return the given default value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - The optional values to search.</dd><dd><code>def</code> - The default value if no value is found in the list.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The first value available in the given list of optional values. If none is found return the given default value.</dd></dl>
</li>
</ul>
<a name="nullablefindFirst(fj.data.List, fj.P1)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nullablefindFirst</h4>
<pre>public static <X> X nullablefindFirst(<a href="../../fj/data/List.html" title="class in fj.data">List</a><X> values,
<a href="../../fj/P1.html" title="class in fj">P1</a><X> def)</pre>
<div class="block">Returns the first non-<code>null</code> value in the given list of optional values. If none is found return the given default value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - The potentially <code>null</code> values to search.</dd><dd><code>def</code> - The default value if no value is found in the list.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The first non-<code>null</code> value in the given list of optional values. If none is found return the given default value.</dd></dl>
</li>
</ul>
<a name="visitor(fj.data.List,fj.P1,java.lang.Object)">
<!-- -->
</a><a name="visitor(fj.data.List, fj.P1, A)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>visitor</h4>
<pre>public static <A,B> B visitor(<a href="../../fj/data/List.html" title="class in fj.data">List</a><<a href="../../fj/F.html" title="class in fj">F</a><A,<a href="../../fj/data/Option.html" title="class in fj.data">Option</a><B>>> visitors,
<a href="../../fj/P1.html" title="class in fj">P1</a><B> def,
A value)</pre>
<div class="block">Returns the first value found in the list of visitors after application of the given value, otherwise returns the
given default.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>visitors</code> - The list of visitors to apply.</dd><dd><code>def</code> - The default if none of the visitors yield a value.</dd><dd><code>value</code> - The value to apply to the visitors.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The first value found in the list of visitors after application of the given value, otherwise returns the
given default.</dd></dl>
</li>
</ul>
<a name="nullableVisitor(fj.data.List,fj.P1,java.lang.Object)">
<!-- -->
</a><a name="nullableVisitor(fj.data.List, fj.P1, A)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nullableVisitor</h4>
<pre>public static <A,B> B nullableVisitor(<a href="../../fj/data/List.html" title="class in fj.data">List</a><<a href="../../fj/F.html" title="class in fj">F</a><A,B>> visitors,
<a href="../../fj/P1.html" title="class in fj">P1</a><B> def,
A value)</pre>
<div class="block">Returns the first non-<code>null</code> value found in the list of visitors after application of the given value,
otherwise returns the given default.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>visitors</code> - The list of visitors to apply looking for a non-<code>null</code>.</dd><dd><code>def</code> - The default if none of the visitors yield a non-<code>null</code> value.</dd><dd><code>value</code> - The value to apply to the visitors.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The first value found in the list of visitors after application of the given value, otherwise returns the
given default.</dd></dl>
</li>
</ul>
<a name="association(fj.data.List, fj.Equal)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>association</h4>
<pre>public static <A,B> <a href="../../fj/F.html" title="class in fj">F</a><B,<a href="../../fj/F.html" title="class in fj">F</a><A,B>> association(<a href="../../fj/data/List.html" title="class in fj.data">List</a><<a href="../../fj/P2.html" title="class in fj">P2</a><A,B>> x,
<a href="../../fj/Equal.html" title="class in fj">Equal</a><A> eq)</pre>
<div class="block">Uses an association list to perform a lookup with equality and returns a function that can be applied to a default,
followed by the associated key to return a value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - The association list.</dd><dd><code>eq</code> - The equality for the association list keys.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A function that can be applied to a default value (there is no association) and an associated key.</dd></dl>
</li>
</ul>
<a name="associationLazy(fj.data.List, fj.Equal)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>associationLazy</h4>
<pre>public static <A,B> <a href="../../fj/F.html" title="class in fj">F</a><<a href="../../fj/P1.html" title="class in fj">P1</a><B>,<a href="../../fj/F.html" title="class in fj">F</a><A,B>> associationLazy(<a href="../../fj/data/List.html" title="class in fj.data">List</a><<a href="../../fj/P2.html" title="class in fj">P2</a><A,B>> x,
<a href="../../fj/Equal.html" title="class in fj">Equal</a><A> eq)</pre>
<div class="block">Uses an association list to perform a lookup with equality and returns a function that can be applied to a default,
followed by the associated key to return a value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - The association list.</dd><dd><code>eq</code> - The equality for the association list keys.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A function that can be applied to a default value (there is no association) and an associated key.</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="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">
<ul class="navList">
<li><a href="../../fj/function/Strings.html" title="class in fj.function"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../index.html?fj/function/Visitor.html" target="_top">Frames</a></li>
<li><a href="Visitor.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>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>