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
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
|
<!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_201) on Tue Jun 16 07:41:33 AEST 2020 -->
<title>JRef</title>
<meta name="date" content="2020-06-16">
<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="JRef";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":42,"i7":10,"i8":10,"i9":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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="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="../../org/jpl7/JPLException.html" title="class in org.jpl7"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../org/jpl7/PrologException.html" title="class in org.jpl7"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?org/jpl7/JRef.html" target="_top">Frames</a></li>
<li><a href="JRef.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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.jpl7</div>
<h2 title="Class JRef" class="title">Class JRef</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../org/jpl7/Term.html" title="class in org.jpl7">org.jpl7.Term</a></li>
<li>
<ul class="inheritance">
<li>org.jpl7.JRef</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">JRef</span>
extends <a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a></pre>
<div class="block">JRef is a specialised Term with a (non-null, non-String) Object field, representing JPL 7.4's Prolog references to Java objects, e.g.
<jref>(0x01D8000).
<hr>
Copyright (C) 2004-2017 Paul Singleton
<p>
Copyright (C) 1998 Fred Dushin
<p>
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are
met:
<ol>
<li>Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
<li>Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
</ol>
<p>
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
<hr></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../org/jpl7/Term.html" title="class in org.jpl7"><code>Term</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/JRef.html#object">object</a></span></code>
<div class="block">the JRef's value (a non-null, non-String Object)</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== 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/jpl7/JRef.html#JRef-java.lang.Object-">JRef</a></span>(java.lang.Object object)</code>
<div class="block">This constructor creates a JRef, initialized with the supplied (non-null, non-String) Object.</div>
</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/JRef.html#atomType--">atomType</a></span>()</code> </td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/JRef.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object o)</code> </td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/JRef.html#hasFunctor-java.lang.String-int-">hasFunctor</a></span>(java.lang.String name,
int arity)</code>
<div class="block">Whether this Term's functor has 'name' and 'arity' (c.f.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/JRef.html#hashCode--">hashCode</a></span>()</code> </td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/JRef.html#object--">object</a></span>()</code>
<div class="block">Returns the actual object the JREF stands for</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/JRef.html#put-java.util.Map-org.jpl7.fli.term_t-">put</a></span>(java.util.Map<java.lang.String,<a href="../../org/jpl7/fli/term_t.html" title="class in org.jpl7.fli">term_t</a>> varnames_to_vars,
<a href="../../org/jpl7/fli/term_t.html" title="class in org.jpl7.fli">term_t</a> term)</code>
<div class="block">To convert a JRef to a term, we put its Object field (.ref) into the term_t as a <jref>(0x01DF800) blob.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/JRef.html#ref--">ref</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="block"><span class="deprecationComment"><a href="../../org/jpl7/JRef.html#object--"><code>object()</code></a></span></div>
</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/JRef.html#toString--">toString</a></span>()</code>
<div class="block">Returns a Prolog source text representation of this JRef</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/JRef.html#type--">type</a></span>()</code>
<div class="block">returns the type of this term, as one of org.jpl7.fli.Prolog.COMPOUND, .ATOM, .VARIABLE, .INTEGER, .FLOAT etc</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jpl7/JRef.html#typeName--">typeName</a></span>()</code>
<div class="block">returns the name of the type of this term, as one of "Compound", "Atom", "Variable", "Integer", "Float" or "JRef"</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.jpl7.Term">
<!-- -->
</a>
<h3>Methods inherited from class org.jpl7.<a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a></h3>
<code><a href="../../org/jpl7/Term.html#arg-int-">arg</a>, <a href="../../org/jpl7/Term.html#args--">args</a>, <a href="../../org/jpl7/Term.html#arity--">arity</a>, <a href="../../org/jpl7/Term.html#atomListToStringArray-org.jpl7.Term-">atomListToStringArray</a>, <a href="../../org/jpl7/Term.html#bigValue--">bigValue</a>, <a href="../../org/jpl7/Term.html#doubleValue--">doubleValue</a>, <a href="../../org/jpl7/Term.html#floatValue--">floatValue</a>, <a href="../../org/jpl7/Term.html#getSubst-java.util.Map-java.util.Map-">getSubst</a>, <a href="../../org/jpl7/Term.html#getSubsts-java.util.Map-java.util.Map-org.jpl7.Term:A-">getSubsts</a>, <a href="../../org/jpl7/Term.html#getTerm-java.util.Map-org.jpl7.fli.term_t-">getTerm</a>, <a href="../../org/jpl7/Term.html#getTerm-org.jpl7.fli.term_t-">getTerm</a>, <a href="../../org/jpl7/Term.html#hasFunctor-java.math.BigInteger-int-">hasFunctor</a>, <a href="../../org/jpl7/Term.html#hasFunctor-double-int-">hasFunctor</a>, <a href="../../org/jpl7/Term.html#hasFunctor-long-int-">hasFunctor</a>, <a href="../../org/jpl7/Term.html#intArrayArrayToList-int:A:A-">intArrayArrayToList</a>, <a href="../../org/jpl7/Term.html#intArrayToList-int:A-">intArrayToList</a>, <a href="../../org/jpl7/Term.html#intValue--">intValue</a>, <a href="../../org/jpl7/Term.html#isAtom--">isAtom</a>, <a href="../../org/jpl7/Term.html#isAtomOfNameType-java.lang.String-java.lang.String-">isAtomOfNameType</a>, <a href="../../org/jpl7/Term.html#isBig--">isBig</a>, <a href="../../org/jpl7/Term.html#isBigInteger--">isBigInteger</a>, <a href="../../org/jpl7/Term.html#isCompound--">isCompound</a>, <a href="../../org/jpl7/Term.html#isFloat--">isFloat</a>, <a href="../../org/jpl7/Term.html#isInteger--">isInteger</a>, <a href="../../org/jpl7/Term.html#isJFalse--">isJFalse</a>, <a href="../../org/jpl7/Term.html#isJNull--">isJNull</a>, <a href="../../org/jpl7/Term.html#isJRef--">isJRef</a>, <a href="../../org/jpl7/Term.html#isJTrue--">isJTrue</a>, <a href="../../org/jpl7/Term.html#isJVoid--">isJVoid</a>, <a href="../../org/jpl7/Term.html#isList--">isList</a>, <a href="../../org/jpl7/Term.html#isList-org.jpl7.Term-">isList</a>, <a href="../../org/jpl7/Term.html#isListNil--">isListNil</a>, <a href="../../org/jpl7/Term.html#isListPair--">isListPair</a>, <a href="../../org/jpl7/Term.html#isVariable--">isVariable</a>, <a href="../../org/jpl7/Term.html#jrefToObject--">jrefToObject</a>, <a href="../../org/jpl7/Term.html#listLength--">listLength</a>, <a href="../../org/jpl7/Term.html#listLength-org.jpl7.Term-">listLength</a>, <a href="../../org/jpl7/Term.html#listToTermArray--">listToTermArray</a>, <a href="../../org/jpl7/Term.html#listToTermArray-org.jpl7.Term-">listToTermArray</a>, <a href="../../org/jpl7/Term.html#longValue--">longValue</a>, <a href="../../org/jpl7/Term.html#name--">name</a>, <a href="../../org/jpl7/Term.html#objectToJRef-java.lang.Object-">objectToJRef</a>, <a href="../../org/jpl7/Term.html#put-org.jpl7.fli.term_t-">put</a>, <a href="../../org/jpl7/Term.html#putParams-org.jpl7.Term-">putParams</a>, <a href="../../org/jpl7/Term.html#putParams-org.jpl7.Term:A-">putParams</a>, <a href="../../org/jpl7/Term.html#putParams1-org.jpl7.fli.IntHolder-org.jpl7.Term:A-">putParams1</a>, <a href="../../org/jpl7/Term.html#putParams2-org.jpl7.Term:A-org.jpl7.fli.IntHolder-org.jpl7.Term:A-">putParams2</a>, <a href="../../org/jpl7/Term.html#putTerm-java.lang.Object-org.jpl7.fli.term_t-">putTerm</a>, <a href="../../org/jpl7/Term.html#putTerms-java.util.Map-org.jpl7.Term:A-">putTerms</a>, <a href="../../org/jpl7/Term.html#setName-java.lang.String-">setName</a>, <a href="../../org/jpl7/Term.html#stringArrayToList-java.lang.String:A-">stringArrayToList</a>, <a href="../../org/jpl7/Term.html#termArrayToList-org.jpl7.Term:A-">termArrayToList</a>, <a href="../../org/jpl7/Term.html#textParamsToTerm-java.lang.String-org.jpl7.Term:A-">textParamsToTerm</a>, <a href="../../org/jpl7/Term.html#textToTerm-java.lang.String-">textToTerm</a>, <a href="../../org/jpl7/Term.html#toString-org.jpl7.Term:A-">toString</a>, <a href="../../org/jpl7/Term.html#toTermArray--">toTermArray</a></code></li>
</ul>
<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, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="object">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>object</h4>
<pre>protected final java.lang.Object object</pre>
<div class="block">the JRef's value (a non-null, non-String Object)</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="JRef-java.lang.Object-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>JRef</h4>
<pre>public JRef(java.lang.Object object)</pre>
<div class="block">This constructor creates a JRef, initialized with the supplied (non-null, non-String) Object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>object</code> - this JRef's value (a non-null, non-String Object)</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="atomType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>atomType</h4>
<pre>public final java.lang.String atomType()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../org/jpl7/Term.html#atomType--">atomType</a></code> in class <code><a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the type ("text", "string", "reserved_symbol", "jref" etc.) of an Atom</dd>
</dl>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public boolean equals(java.lang.Object o)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public int hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="hasFunctor-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasFunctor</h4>
<pre>public boolean hasFunctor(java.lang.String name,
int arity)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../org/jpl7/Term.html#hasFunctor-java.lang.String-int-">Term</a></code></span></div>
<div class="block">Whether this Term's functor has 'name' and 'arity' (c.f. behaviour of SWI Prolog's functor/3)</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../org/jpl7/Term.html#hasFunctor-java.lang.String-int-">hasFunctor</a></code> in class <code><a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - a possible name for the functor of a term</dd>
<dd><code>arity</code> - an arity 0+</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether this Term's functor has 'name' and 'arity'</dd>
</dl>
</li>
</ul>
<a name="object--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>object</h4>
<pre>public java.lang.Object object()</pre>
<div class="block">Returns the actual object the JREF stands for</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../org/jpl7/Term.html#object--">object</a></code> in class <code><a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the object of the JREF term</dd>
</dl>
</li>
</ul>
<a name="put-java.util.Map-org.jpl7.fli.term_t-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>put</h4>
<pre>protected final void put(java.util.Map<java.lang.String,<a href="../../org/jpl7/fli/term_t.html" title="class in org.jpl7.fli">term_t</a>> varnames_to_vars,
<a href="../../org/jpl7/fli/term_t.html" title="class in org.jpl7.fli">term_t</a> term)</pre>
<div class="block">To convert a JRef to a term, we put its Object field (.ref) into the term_t as a <jref>(0x01DF800) blob.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../org/jpl7/Term.html#put-java.util.Map-org.jpl7.fli.term_t-">put</a></code> in class <code><a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>varnames_to_vars</code> - A Map from variable names to Prolog variables.</dd>
<dd><code>term</code> - A (newly created) term_t which is to be set to a Prolog <jref>(0x01DF800) blob denoting the .ref of this JRef
instance</dd>
</dl>
</li>
</ul>
<a name="ref--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ref</h4>
<pre>@Deprecated
public java.lang.Object ref()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment"><a href="../../org/jpl7/JRef.html#object--"><code>object()</code></a></span></div>
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../org/jpl7/Term.html#ref--">Term</a></code></span></div>
<div class="block">The (non-null, non-String) object which this org.jpl7.JRef references.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../org/jpl7/Term.html#ref--">ref</a></code> in class <code><a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the (non-null, non-String) object which this org.jpl7.JRef references.</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<div class="block">Returns a Prolog source text representation of this JRef</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a Prolog source text representation of this JRef</dd>
</dl>
</li>
</ul>
<a name="type--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>type</h4>
<pre>public final int type()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../org/jpl7/Term.html#type--">Term</a></code></span></div>
<div class="block">returns the type of this term, as one of org.jpl7.fli.Prolog.COMPOUND, .ATOM, .VARIABLE, .INTEGER, .FLOAT etc</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../org/jpl7/Term.html#type--">type</a></code> in class <code><a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the type of this term, as one of org.jpl7.fli.Prolog.COMPOUND, .ATOM, .VARIABLE, .INTEGER, .FLOAT etc</dd>
</dl>
</li>
</ul>
<a name="typeName--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>typeName</h4>
<pre>public java.lang.String typeName()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../org/jpl7/Term.html#typeName--">Term</a></code></span></div>
<div class="block">returns the name of the type of this term, as one of "Compound", "Atom", "Variable", "Integer", "Float" or "JRef"</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../org/jpl7/Term.html#typeName--">typeName</a></code> in class <code><a href="../../org/jpl7/Term.html" title="class in org.jpl7">Term</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of the type of this term, as one of "Compound", "Atom", "Variable", "Integer", "Float" or "JRef"</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="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="../../org/jpl7/JPLException.html" title="class in org.jpl7"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../org/jpl7/PrologException.html" title="class in org.jpl7"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?org/jpl7/JRef.html" target="_top">Frames</a></li>
<li><a href="JRef.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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>
|
