| <!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_101) on Sun Apr 09 00:39:32 CEST 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>VelocityScriptEngine (Apache Velocity 2.0 API)</title> |
| <meta name="date" content="2017-04-09"> |
| <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="VelocityScriptEngine (Apache Velocity 2.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":9,"i7":9,"i8":10,"i9":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance 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/VelocityScriptEngine.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-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/apache/velocity/script/VelocityCompiledScript.html" title="class in org.apache.velocity.script"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/velocity/script/VelocityScriptEngine.SingleResourceReader.html" title="class in org.apache.velocity.script"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/velocity/script/VelocityScriptEngine.html" target="_top">Frames</a></li> |
| <li><a href="VelocityScriptEngine.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><a href="#nested.class.summary">Nested</a> | </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.apache.velocity.script</div> |
| <h2 title="Class VelocityScriptEngine" class="title">Class VelocityScriptEngine</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/7/docs/api/javax/script/AbstractScriptEngine.html?is-external=true" title="class or interface in javax.script">javax.script.AbstractScriptEngine</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.velocity.script.VelocityScriptEngine</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="http://docs.oracle.com/javase/7/docs/api/javax/script/Compilable.html?is-external=true" title="class or interface in javax.script">Compilable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptEngine.html?is-external=true" title="class or interface in javax.script">ScriptEngine</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">VelocityScriptEngine</span> |
| extends <a href="http://docs.oracle.com/javase/7/docs/api/javax/script/AbstractScriptEngine.html?is-external=true" title="class or interface in javax.script">AbstractScriptEngine</a> |
| implements <a href="http://docs.oracle.com/javase/7/docs/api/javax/script/Compilable.html?is-external=true" title="class or interface in javax.script">Compilable</a></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/script/VelocityScriptEngine.SingleResourceReader.html" title="class in org.apache.velocity.script">VelocityScriptEngine.SingleResourceReader</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== 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>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/script/VelocityScriptEngine.html#VELOCITY_PROPERTIES_KEY">VELOCITY_PROPERTIES_KEY</a></span></code> |
| <div class="block">Key used to provide this engine with the pathname of the Velocity properties file.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.javax.script.AbstractScriptEngine"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class javax.script.<a href="http://docs.oracle.com/javase/7/docs/api/javax/script/AbstractScriptEngine.html?is-external=true" title="class or interface in javax.script">AbstractScriptEngine</a></h3> |
| <code><a href="http://docs.oracle.com/javase/7/docs/api/javax/script/AbstractScriptEngine.html?is-external=true#context" title="class or interface in javax.script">context</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.javax.script.ScriptEngine"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface javax.script.<a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptEngine.html?is-external=true" title="class or interface in javax.script">ScriptEngine</a></h3> |
| <code><a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptEngine.html?is-external=true#ARGV" title="class or interface in javax.script">ARGV</a>, <a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptEngine.html?is-external=true#ENGINE" title="class or interface in javax.script">ENGINE</a>, <a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptEngine.html?is-external=true#ENGINE_VERSION" title="class or interface in javax.script">ENGINE_VERSION</a>, <a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptEngine.html?is-external=true#FILENAME" title="class or interface in javax.script">FILENAME</a>, <a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptEngine.html?is-external=true#LANGUAGE" title="class or interface in javax.script">LANGUAGE</a>, <a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptEngine.html?is-external=true#LANGUAGE_VERSION" title="class or interface in javax.script">LANGUAGE_VERSION</a>, <a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptEngine.html?is-external=true#NAME" title="class or interface in javax.script">NAME</a></code></li> |
| </ul> |
| </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/apache/velocity/script/VelocityScriptEngine.html#VelocityScriptEngine--">VelocityScriptEngine</a></span>()</code> |
| <div class="block">constructs a new standalone Velocity script engine</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/script/VelocityScriptEngine.html#VelocityScriptEngine-javax.script.ScriptEngineFactory-">VelocityScriptEngine</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptEngineFactory.html?is-external=true" title="class or interface in javax.script">ScriptEngineFactory</a> factory)</code> |
| <div class="block">constructs a new Velocity script engine, linked to the given factory</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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></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><a href="http://docs.oracle.com/javase/7/docs/api/javax/script/CompiledScript.html?is-external=true" title="class or interface in javax.script">CompiledScript</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/script/VelocityScriptEngine.html#compile-java.io.Reader-">compile</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> script)</code> |
| <div class="block">Compile a template</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/javax/script/CompiledScript.html?is-external=true" title="class or interface in javax.script">CompiledScript</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/script/VelocityScriptEngine.html#compile-java.lang.String-">compile</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> script)</code> |
| <div class="block">Compile a template</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/javax/script/Bindings.html?is-external=true" title="class or interface in javax.script">Bindings</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/script/VelocityScriptEngine.html#createBindings--">createBindings</a></span>()</code> |
| <div class="block">creates a new Bindings to be used with this script</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/script/VelocityScriptEngine.html#eval-java.io.Reader-javax.script.ScriptContext-">eval</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> reader, |
| <a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptContext.html?is-external=true" title="class or interface in javax.script">ScriptContext</a> ctx)</code> |
| <div class="block">Evaluate the given script.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/script/VelocityScriptEngine.html#eval-java.lang.String-javax.script.ScriptContext-">eval</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> str, |
| <a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptContext.html?is-external=true" title="class or interface in javax.script">ScriptContext</a> ctx)</code> |
| <div class="block">Evaluate the given script.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptEngineFactory.html?is-external=true" title="class or interface in javax.script">ScriptEngineFactory</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/script/VelocityScriptEngine.html#getFactory--">getFactory</a></span>()</code> |
| <div class="block">get the factory used to create this script engine</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>protected static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/script/VelocityScriptEngine.html#getFilename-javax.script.ScriptContext-">getFilename</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptContext.html?is-external=true" title="class or interface in javax.script">ScriptContext</a> ctx)</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>protected static <a href="../../../../org/apache/velocity/VelocityContext.html" title="class in org.apache.velocity">VelocityContext</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/script/VelocityScriptEngine.html#getVelocityContext-javax.script.ScriptContext-">getVelocityContext</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptContext.html?is-external=true" title="class or interface in javax.script">ScriptContext</a> ctx)</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html" title="class in org.apache.velocity.runtime">RuntimeInstance</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/script/VelocityScriptEngine.html#getVelocityEngine--">getVelocityEngine</a></span>()</code> |
| <div class="block">get the internal Velocity RuntimeInstance</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>protected static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/script/VelocityScriptEngine.html#getVelocityProperties-javax.script.ScriptContext-">getVelocityProperties</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptContext.html?is-external=true" title="class or interface in javax.script">ScriptContext</a> ctx)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.javax.script.AbstractScriptEngine"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class javax.script.<a href="http://docs.oracle.com/javase/7/docs/api/javax/script/AbstractScriptEngine.html?is-external=true" title="class or interface in javax.script">AbstractScriptEngine</a></h3> |
| <code><a href="http://docs.oracle.com/javase/7/docs/api/javax/script/AbstractScriptEngine.html?is-external=true#eval-java.io.Reader-" title="class or interface in javax.script">eval</a>, <a href="http://docs.oracle.com/javase/7/docs/api/javax/script/AbstractScriptEngine.html?is-external=true#eval-java.io.Reader-javax.script.Bindings-" title="class or interface in javax.script">eval</a>, <a href="http://docs.oracle.com/javase/7/docs/api/javax/script/AbstractScriptEngine.html?is-external=true#eval-java.lang.String-" title="class or interface in javax.script">eval</a>, <a href="http://docs.oracle.com/javase/7/docs/api/javax/script/AbstractScriptEngine.html?is-external=true#eval-java.lang.String-javax.script.Bindings-" title="class or interface in javax.script">eval</a>, <a href="http://docs.oracle.com/javase/7/docs/api/javax/script/AbstractScriptEngine.html?is-external=true#get-java.lang.String-" title="class or interface in javax.script">get</a>, <a href="http://docs.oracle.com/javase/7/docs/api/javax/script/AbstractScriptEngine.html?is-external=true#getBindings-int-" title="class or interface in javax.script">getBindings</a>, <a href="http://docs.oracle.com/javase/7/docs/api/javax/script/AbstractScriptEngine.html?is-external=true#getContext--" title="class or interface in javax.script">getContext</a>, <a href="http://docs.oracle.com/javase/7/docs/api/javax/script/AbstractScriptEngine.html?is-external=true#getScriptContext-javax.script.Bindings-" title="class or interface in javax.script">getScriptContext</a>, <a href="http://docs.oracle.com/javase/7/docs/api/javax/script/AbstractScriptEngine.html?is-external=true#put-java.lang.String-java.lang.Object-" title="class or interface in javax.script">put</a>, <a href="http://docs.oracle.com/javase/7/docs/api/javax/script/AbstractScriptEngine.html?is-external=true#setBindings-javax.script.Bindings-int-" title="class or interface in javax.script">setBindings</a>, <a href="http://docs.oracle.com/javase/7/docs/api/javax/script/AbstractScriptEngine.html?is-external=true#setContext-javax.script.ScriptContext-" title="class or interface in javax.script">setContext</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.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></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="VELOCITY_PROPERTIES_KEY"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>VELOCITY_PROPERTIES_KEY</h4> |
| <pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> VELOCITY_PROPERTIES_KEY</pre> |
| <div class="block">Key used to provide this engine with the pathname of the Velocity properties file. |
| This key is first searched in the ScriptContext attributes, then as a System property</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.velocity.script.VelocityScriptEngine.VELOCITY_PROPERTIES_KEY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="VelocityScriptEngine-javax.script.ScriptEngineFactory-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>VelocityScriptEngine</h4> |
| <pre>public VelocityScriptEngine(<a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptEngineFactory.html?is-external=true" title="class or interface in javax.script">ScriptEngineFactory</a> factory)</pre> |
| <div class="block">constructs a new Velocity script engine, linked to the given factory</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>factory</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="VelocityScriptEngine--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>VelocityScriptEngine</h4> |
| <pre>public VelocityScriptEngine()</pre> |
| <div class="block">constructs a new standalone Velocity script engine</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getVelocityEngine--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getVelocityEngine</h4> |
| <pre>protected <a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html" title="class in org.apache.velocity.runtime">RuntimeInstance</a> getVelocityEngine()</pre> |
| <div class="block">get the internal Velocity RuntimeInstance</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the internal Velocity RuntimeInstance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="eval-java.lang.String-javax.script.ScriptContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>eval</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> eval(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> str, |
| <a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptContext.html?is-external=true" title="class or interface in javax.script">ScriptContext</a> ctx) |
| throws <a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptException.html?is-external=true" title="class or interface in javax.script">ScriptException</a></pre> |
| <div class="block">Evaluate the given script. |
| If you wish to get a resulting string, call getContext().setWriter(new StringWriter()) then call toString() |
| on the returned writer.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptEngine.html?is-external=true#eval-java.lang.String-javax.script.ScriptContext-" title="class or interface in javax.script">eval</a></code> in interface <code><a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptEngine.html?is-external=true" title="class or interface in javax.script">ScriptEngine</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>str</code> - script source</dd> |
| <dd><code>ctx</code> - script context</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the script context writer (by default a PrintWriter towards System.out)</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptException.html?is-external=true" title="class or interface in javax.script">ScriptException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="eval-java.io.Reader-javax.script.ScriptContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>eval</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> eval(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> reader, |
| <a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptContext.html?is-external=true" title="class or interface in javax.script">ScriptContext</a> ctx) |
| throws <a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptException.html?is-external=true" title="class or interface in javax.script">ScriptException</a></pre> |
| <div class="block">Evaluate the given script. |
| If you wish to get a resulting string, call getContext().setWriter(new StringWriter()) then call toString() |
| on the returned writer.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptEngine.html?is-external=true#eval-java.io.Reader-javax.script.ScriptContext-" title="class or interface in javax.script">eval</a></code> in interface <code><a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptEngine.html?is-external=true" title="class or interface in javax.script">ScriptEngine</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>reader</code> - script source reader</dd> |
| <dd><code>ctx</code> - script context</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the script context writer (by default a PrintWriter towards System.out)</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptException.html?is-external=true" title="class or interface in javax.script">ScriptException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFactory--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFactory</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptEngineFactory.html?is-external=true" title="class or interface in javax.script">ScriptEngineFactory</a> getFactory()</pre> |
| <div class="block">get the factory used to create this script engine</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptEngine.html?is-external=true#getFactory--" title="class or interface in javax.script">getFactory</a></code> in interface <code><a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptEngine.html?is-external=true" title="class or interface in javax.script">ScriptEngine</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>factory</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createBindings--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createBindings</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/javax/script/Bindings.html?is-external=true" title="class or interface in javax.script">Bindings</a> createBindings()</pre> |
| <div class="block">creates a new Bindings to be used with this script</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptEngine.html?is-external=true#createBindings--" title="class or interface in javax.script">createBindings</a></code> in interface <code><a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptEngine.html?is-external=true" title="class or interface in javax.script">ScriptEngine</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>new bindings</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getVelocityContext-javax.script.ScriptContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getVelocityContext</h4> |
| <pre>protected static <a href="../../../../org/apache/velocity/VelocityContext.html" title="class in org.apache.velocity">VelocityContext</a> getVelocityContext(<a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptContext.html?is-external=true" title="class or interface in javax.script">ScriptContext</a> ctx)</pre> |
| </li> |
| </ul> |
| <a name="getFilename-javax.script.ScriptContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFilename</h4> |
| <pre>protected static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getFilename(<a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptContext.html?is-external=true" title="class or interface in javax.script">ScriptContext</a> ctx)</pre> |
| </li> |
| </ul> |
| <a name="getVelocityProperties-javax.script.ScriptContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getVelocityProperties</h4> |
| <pre>protected static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> getVelocityProperties(<a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptContext.html?is-external=true" title="class or interface in javax.script">ScriptContext</a> ctx)</pre> |
| </li> |
| </ul> |
| <a name="compile-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>compile</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/javax/script/CompiledScript.html?is-external=true" title="class or interface in javax.script">CompiledScript</a> compile(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> script) |
| throws <a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptException.html?is-external=true" title="class or interface in javax.script">ScriptException</a></pre> |
| <div class="block">Compile a template</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/javax/script/Compilable.html?is-external=true#compile-java.lang.String-" title="class or interface in javax.script">compile</a></code> in interface <code><a href="http://docs.oracle.com/javase/7/docs/api/javax/script/Compilable.html?is-external=true" title="class or interface in javax.script">Compilable</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>script</code> - template source</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>compiled template</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptException.html?is-external=true" title="class or interface in javax.script">ScriptException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="compile-java.io.Reader-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>compile</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/javax/script/CompiledScript.html?is-external=true" title="class or interface in javax.script">CompiledScript</a> compile(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> script) |
| throws <a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptException.html?is-external=true" title="class or interface in javax.script">ScriptException</a></pre> |
| <div class="block">Compile a template</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/javax/script/Compilable.html?is-external=true#compile-java.io.Reader-" title="class or interface in javax.script">compile</a></code> in interface <code><a href="http://docs.oracle.com/javase/7/docs/api/javax/script/Compilable.html?is-external=true" title="class or interface in javax.script">Compilable</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>script</code> - template source</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>compiled template</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/javax/script/ScriptException.html?is-external=true" title="class or interface in javax.script">ScriptException</a></code></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/VelocityScriptEngine.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-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/apache/velocity/script/VelocityCompiledScript.html" title="class in org.apache.velocity.script"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/velocity/script/VelocityScriptEngine.SingleResourceReader.html" title="class in org.apache.velocity.script"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/velocity/script/VelocityScriptEngine.html" target="_top">Frames</a></li> |
| <li><a href="VelocityScriptEngine.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><a href="#nested.class.summary">Nested</a> | </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 ======= --> |
| <p class="legalCopy"><small>Copyright © 2000–2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
