Repository navigation
Expand file tree
/
Copy pathScriptEngineFactory.html
More file actions
619 lines (616 loc) · 28.6 KB
/
Copy pathScriptEngineFactory.html
File metadata and controls
619 lines (616 loc) · 28.6 KB
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
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ScriptEngineFactory (Java SE 12 & JDK 12 )</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="keywords" content="javax.script.ScriptEngineFactory interface">
<meta name="keywords" content="getEngineName()">
<meta name="keywords" content="getEngineVersion()">
<meta name="keywords" content="getExtensions()">
<meta name="keywords" content="getMimeTypes()">
<meta name="keywords" content="getNames()">
<meta name="keywords" content="getLanguageName()">
<meta name="keywords" content="getLanguageVersion()">
<meta name="keywords" content="getParameter()">
<meta name="keywords" content="getMethodCallSyntax()">
<meta name="keywords" content="getOutputStatement()">
<meta name="keywords" content="getProgram()">
<meta name="keywords" content="getScriptEngine()">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ScriptEngineFactory (Java SE 12 & JDK 12 )";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= 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><a href="../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ScriptEngineFactory.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 class="aboutLanguage"><div style="margin-top: 14px;"><strong>Java SE 12 & JDK 12</strong> </div></div>
</div>
<div class="subNav">
<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>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding"> </div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="moduleLabelInType">Module</span> <a href="../../module-summary.html">java.scripting</a></div>
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">javax.script</a></div>
<h2 title="Interface ScriptEngineFactory" class="title">Interface ScriptEngineFactory</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../../../jdk.scripting.nashorn/jdk/nashorn/api/scripting/NashornScriptEngineFactory.html" title="class in jdk.nashorn.api.scripting">NashornScriptEngineFactory</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">ScriptEngineFactory</span></pre>
<div class="block"><code>ScriptEngineFactory</code> is used to describe and instantiate
<code>ScriptEngines</code>.
<br><br>
Each class implementing <code>ScriptEngine</code> has a corresponding
factory that exposes metadata describing the engine class.
<br><br>The <code>ScriptEngineManager</code>
uses the service-provider loader mechanism described in the
<a href="../../../java.base/java/util/ServiceLoader.html" title="class in java.util"><code>ServiceLoader</code></a> class to obtain
instances of <code>ScriptEngineFactory</code> instances.
See <a href="ScriptEngineManager.html#%3Cinit%3E()"><code>ScriptEngineManager()</code></a> and
<a href="ScriptEngineManager.html#%3Cinit%3E(java.lang.ClassLoader)"><code>ScriptEngineManager(java.lang.ClassLoader)</code></a>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<div class="memberSummary">
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Abstract Methods</button></div>
<div id="memberSummary_tabpanel" role="tabpanel">
<table aria-labelledby="t0">
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor" id="i0">
<td class="colFirst"><code><a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEngineName()">getEngineName</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the full name of the <code>ScriptEngine</code>.</div>
</td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code><a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEngineVersion()">getEngineVersion</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the version of the <code>ScriptEngine</code>.</div>
</td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code><a href="../../../java.base/java/util/List.html" title="interface in java.util">List</a><<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a>></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExtensions()">getExtensions</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns an immutable list of filename extensions, which generally identify scripts
written in the language supported by this <code>ScriptEngine</code>.</div>
</td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code><a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLanguageName()">getLanguageName</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the name of the scripting language supported by this
<code>ScriptEngine</code>.</div>
</td>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><code><a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLanguageVersion()">getLanguageVersion</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the version of the scripting language supported by this
<code>ScriptEngine</code>.</div>
</td>
</tr>
<tr class="rowColor" id="i5">
<td class="colFirst"><code><a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMethodCallSyntax(java.lang.String,java.lang.String,java.lang.String...)">getMethodCallSyntax</a></span>​(<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a> obj,
<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a> m,
<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a>... args)</code></th>
<td class="colLast">
<div class="block">Returns a String which can be used to invoke a method of a Java object using the syntax
of the supported scripting language.</div>
</td>
</tr>
<tr class="altColor" id="i6">
<td class="colFirst"><code><a href="../../../java.base/java/util/List.html" title="interface in java.util">List</a><<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a>></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMimeTypes()">getMimeTypes</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns an immutable list of mimetypes, associated with scripts that
can be executed by the engine.</div>
</td>
</tr>
<tr class="rowColor" id="i7">
<td class="colFirst"><code><a href="../../../java.base/java/util/List.html" title="interface in java.util">List</a><<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a>></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNames()">getNames</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns an immutable list of short names for the <code>ScriptEngine</code>, which may be used to
identify the <code>ScriptEngine</code> by the <code>ScriptEngineManager</code>.</div>
</td>
</tr>
<tr class="altColor" id="i8">
<td class="colFirst"><code><a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOutputStatement(java.lang.String)">getOutputStatement</a></span>​(<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a> toDisplay)</code></th>
<td class="colLast">
<div class="block">Returns a String that can be used as a statement to display the specified String using
the syntax of the supported scripting language.</div>
</td>
</tr>
<tr class="rowColor" id="i9">
<td class="colFirst"><code><a href="../../../java.base/java/lang/Object.html" title="class in java.lang">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParameter(java.lang.String)">getParameter</a></span>​(<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a> key)</code></th>
<td class="colLast">
<div class="block">Returns the value of an attribute whose meaning may be implementation-specific.</div>
</td>
</tr>
<tr class="altColor" id="i10">
<td class="colFirst"><code><a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProgram(java.lang.String...)">getProgram</a></span>​(<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a>... statements)</code></th>
<td class="colLast">
<div class="block">Returns a valid scripting language executable program with given statements.</div>
</td>
</tr>
<tr class="rowColor" id="i11">
<td class="colFirst"><code><a href="ScriptEngine.html" title="interface in javax.script">ScriptEngine</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getScriptEngine()">getScriptEngine</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns an instance of the <code>ScriptEngine</code> associated with this
<code>ScriptEngineFactory</code>.</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getEngineName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEngineName</h4>
<pre class="methodSignature"><a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a> getEngineName()</pre>
<div class="block">Returns the full name of the <code>ScriptEngine</code>. For
instance an implementation based on the Mozilla Rhino Javascript engine
might return <i>Rhino Mozilla Javascript Engine</i>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The name of the engine implementation.</dd>
</dl>
</li>
</ul>
<a id="getEngineVersion()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEngineVersion</h4>
<pre class="methodSignature"><a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a> getEngineVersion()</pre>
<div class="block">Returns the version of the <code>ScriptEngine</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The <code>ScriptEngine</code> implementation version.</dd>
</dl>
</li>
</ul>
<a id="getExtensions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExtensions</h4>
<pre class="methodSignature"><a href="../../../java.base/java/util/List.html" title="interface in java.util">List</a><<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a>> getExtensions()</pre>
<div class="block">Returns an immutable list of filename extensions, which generally identify scripts
written in the language supported by this <code>ScriptEngine</code>.
The array is used by the <code>ScriptEngineManager</code> to implement its
<code>getEngineByExtension</code> method.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The list of extensions.</dd>
</dl>
</li>
</ul>
<a id="getMimeTypes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMimeTypes</h4>
<pre class="methodSignature"><a href="../../../java.base/java/util/List.html" title="interface in java.util">List</a><<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a>> getMimeTypes()</pre>
<div class="block">Returns an immutable list of mimetypes, associated with scripts that
can be executed by the engine. The list is used by the
<code>ScriptEngineManager</code> class to implement its
<code>getEngineByMimetype</code> method.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The list of mime types.</dd>
</dl>
</li>
</ul>
<a id="getNames()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNames</h4>
<pre class="methodSignature"><a href="../../../java.base/java/util/List.html" title="interface in java.util">List</a><<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a>> getNames()</pre>
<div class="block">Returns an immutable list of short names for the <code>ScriptEngine</code>, which may be used to
identify the <code>ScriptEngine</code> by the <code>ScriptEngineManager</code>.
For instance, an implementation based on the Mozilla Rhino Javascript engine might
return list containing {"javascript", "rhino"}.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an immutable list of short names</dd>
</dl>
</li>
</ul>
<a id="getLanguageName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLanguageName</h4>
<pre class="methodSignature"><a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a> getLanguageName()</pre>
<div class="block">Returns the name of the scripting language supported by this
<code>ScriptEngine</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The name of the supported language.</dd>
</dl>
</li>
</ul>
<a id="getLanguageVersion()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLanguageVersion</h4>
<pre class="methodSignature"><a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a> getLanguageVersion()</pre>
<div class="block">Returns the version of the scripting language supported by this
<code>ScriptEngine</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The version of the supported language.</dd>
</dl>
</li>
</ul>
<a id="getParameter(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParameter</h4>
<pre class="methodSignature"><a href="../../../java.base/java/lang/Object.html" title="class in java.lang">Object</a> getParameter​(<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a> key)</pre>
<div class="block">Returns the value of an attribute whose meaning may be implementation-specific.
Keys for which the value is defined in all implementations are:
<ul>
<li>ScriptEngine.ENGINE</li>
<li>ScriptEngine.ENGINE_VERSION</li>
<li>ScriptEngine.LANGUAGE</li>
<li>ScriptEngine.LANGUAGE_VERSION</li>
<li>ScriptEngine.NAME</li>
</ul>
<p>
The values for these keys are the Strings returned by <code>getEngineName</code>,
<code>getEngineVersion</code>, <code>getLanguageName</code>,
<code>getLanguageVersion</code> for the first four keys respectively. For NAME, one of the Strings
returned by <code>getNames</code> is returned.<br><br>
A reserved key, <code><b>THREADING</b></code>, whose value describes the behavior of the engine
with respect to concurrent execution of scripts and maintenance of state is also defined.
These values for the <code><b>THREADING</b></code> key are:<br><br>
<ul>
<li><code>null</code> - The engine implementation is not thread safe, and cannot
be used to execute scripts concurrently on multiple threads.
<li><code>"MULTITHREADED"</code> - The engine implementation is internally
thread-safe and scripts may execute concurrently although effects of script execution
on one thread may be visible to scripts on other threads.
<li><code>"THREAD-ISOLATED"</code> - The implementation satisfies the requirements
of "MULTITHREADED", and also, the engine maintains independent values
for symbols in scripts executing on different threads.
<li><code>"STATELESS"</code> - The implementation satisfies the requirements of
<code>"THREAD-ISOLATED"</code>. In addition, script executions do not alter the
mappings in the <code>Bindings</code> which is the engine scope of the
<code>ScriptEngine</code>. In particular, the keys in the <code>Bindings</code>
and their associated values are the same before and after the execution of the script.
</ul>
<br><br>
Implementations may define implementation-specific keys.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - The name of the parameter</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The value for the given parameter. Returns <code>null</code> if no
value is assigned to the key.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../java.base/java/lang/NullPointerException.html" title="class in java.lang">NullPointerException</a></code> - if the key is null.</dd>
</dl>
</li>
</ul>
<a id="getMethodCallSyntax(java.lang.String,java.lang.String,java.lang.String...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMethodCallSyntax</h4>
<pre class="methodSignature"><a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a> getMethodCallSyntax​(<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a> obj,
<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a> m,
<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a>... args)</pre>
<div class="block">Returns a String which can be used to invoke a method of a Java object using the syntax
of the supported scripting language. For instance, an implementation for a Javascript
engine might be;
<pre><code>
public String getMethodCallSyntax(String obj,
String m, String... args) {
String ret = obj;
ret += "." + m + "(";
for (int i = 0; i < args.length; i++) {
ret += args[i];
if (i < args.length - 1) {
ret += ",";
}
}
ret += ")";
return ret;
}
</code> </pre></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>obj</code> - The name representing the object whose method is to be invoked. The
name is the one used to create bindings using the <code>put</code> method of
<code>ScriptEngine</code>, the <code>put</code> method of an <code>ENGINE_SCOPE</code>
<code>Bindings</code>,or the <code>setAttribute</code> method
of <code>ScriptContext</code>. The identifier used in scripts may be a decorated form of the
specified one.</dd>
<dd><code>m</code> - The name of the method to invoke.</dd>
<dd><code>args</code> - names of the arguments in the method call.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The String used to invoke the method in the syntax of the scripting language.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../java.base/java/lang/NullPointerException.html" title="class in java.lang">NullPointerException</a></code> - if obj or m or args or any of the elements of args is null.</dd>
</dl>
</li>
</ul>
<a id="getOutputStatement(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutputStatement</h4>
<pre class="methodSignature"><a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a> getOutputStatement​(<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a> toDisplay)</pre>
<div class="block">Returns a String that can be used as a statement to display the specified String using
the syntax of the supported scripting language. For instance, the implementation for a Perl
engine might be;
<pre><code>
public String getOutputStatement(String toDisplay) {
return "print(" + toDisplay + ")";
}
</code></pre></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>toDisplay</code> - The String to be displayed by the returned statement.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The string used to display the String in the syntax of the scripting language.</dd>
</dl>
</li>
</ul>
<a id="getProgram(java.lang.String...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProgram</h4>
<pre class="methodSignature"><a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a> getProgram​(<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a>... statements)</pre>
<div class="block">Returns a valid scripting language executable program with given statements.
For instance an implementation for a PHP engine might be:
<pre><code>
public String getProgram(String... statements) {
String retval = "<?\n";
int len = statements.length;
for (int i = 0; i < len; i++) {
retval += statements[i] + ";\n";
}
return retval += "?>";
}
</code></pre></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>statements</code> - The statements to be executed. May be return values of
calls to the <code>getMethodCallSyntax</code> and <code>getOutputStatement</code> methods.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The Program</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../java.base/java/lang/NullPointerException.html" title="class in java.lang">NullPointerException</a></code> - if the <code>statements</code> array or any of its elements is null</dd>
</dl>
</li>
</ul>
<a id="getScriptEngine()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getScriptEngine</h4>
<pre class="methodSignature"><a href="ScriptEngine.html" title="interface in javax.script">ScriptEngine</a> getScriptEngine()</pre>
<div class="block">Returns an instance of the <code>ScriptEngine</code> associated with this
<code>ScriptEngineFactory</code>. A new ScriptEngine is generally
returned, but implementations may pool, share or reuse engines.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A new <code>ScriptEngine</code> instance.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<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><a href="../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ScriptEngineFactory.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 class="aboutLanguage"><div style="margin-top: 14px;"><strong>Java SE 12 & JDK 12</strong> </div></div>
</div>
<div class="subNav">
<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>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small><a href="https://bugreport.java.com/bugreport/">Report a bug or suggest an enhancement</a><br> For further API reference and developer documentation see the <a href="https://docs.oracle.com/pls/topic/lookup?ctx=javase12.0.2&id=homepage" target="_blank">Java SE Documentation</a>, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.<br> Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.<br> <a href="../../../../legal/copyright.html">Copyright</a> © 1993, 2019, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.<br>All rights reserved. Use is subject to <a href="https://www.oracle.com/technetwork/java/javase/terms/license/java12.0.2speclicense.html">license terms</a> and the <a href="https://www.oracle.com/technetwork/java/redist-137594.html">documentation redistribution policy</a>. <!-- Version 12.0.2+10 --></small></p>
</footer>
</body>
</html>