| <!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_281) on Sun Jan 15 15:58:34 CET 2023 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>TemplateClassResolver (FreeMarker 2.3.32 API)</title> |
| <meta name="date" content="2023-01-15"> |
| <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="TemplateClassResolver (FreeMarker 2.3.32 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":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"; |
| </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/TemplateClassResolver.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="../../freemarker/core/StopException.html" title="class in freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../freemarker/core/TemplateCombinedMarkupOutputModel.html" title="class in freemarker.core"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?freemarker/core/TemplateClassResolver.html" target="_top">Frames</a></li> |
| <li><a href="TemplateClassResolver.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>Constr | </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>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">freemarker.core</div> |
| <h2 title="Interface TemplateClassResolver" class="title">Interface TemplateClassResolver</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../freemarker/core/OptInTemplateClassResolver.html" title="class in freemarker.core">OptInTemplateClassResolver</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">TemplateClassResolver</span></pre> |
| <div class="block">Used by built-ins and other template language features that get a class |
| based on a string. This can be handy both for implementing security |
| restrictions and for working around local class-loader issues. |
| |
| The implementation should be thread-safe, unless an |
| instance is always only used in a single <a href="../../freemarker/core/Environment.html" title="class in freemarker.core"><code>Environment</code></a> object.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.3.17</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../freemarker/core/Configurable.html#setNewBuiltinClassResolver-freemarker.core.TemplateClassResolver-"><code>Configurable.setNewBuiltinClassResolver(TemplateClassResolver)</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>static <a href="../../freemarker/core/TemplateClassResolver.html" title="interface in freemarker.core">TemplateClassResolver</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/TemplateClassResolver.html#ALLOWS_NOTHING_RESOLVER">ALLOWS_NOTHING_RESOLVER</a></span></code> |
| <div class="block">Doesn't allow resolving any classes.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../freemarker/core/TemplateClassResolver.html" title="interface in freemarker.core">TemplateClassResolver</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/TemplateClassResolver.html#SAFER_RESOLVER">SAFER_RESOLVER</a></span></code> |
| <div class="block">Same as <a href="../../freemarker/core/TemplateClassResolver.html#UNRESTRICTED_RESOLVER"><code>UNRESTRICTED_RESOLVER</code></a>, except that it doesn't allow |
| resolving <a href="../../freemarker/template/utility/ObjectConstructor.html" title="class in freemarker.template.utility"><code>ObjectConstructor</code></a> and <a href="../../freemarker/template/utility/Execute.html" title="class in freemarker.template.utility"><code>Execute</code></a> and <code>freemarker.template.utility.JythonRuntime</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../freemarker/core/TemplateClassResolver.html" title="interface in freemarker.core">TemplateClassResolver</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/TemplateClassResolver.html#UNRESTRICTED_RESOLVER">UNRESTRICTED_RESOLVER</a></span></code> |
| <div class="block">Simply calls <a href="../../freemarker/template/utility/ClassUtil.html#forName-java.lang.String-"><code>ClassUtil.forName(String)</code></a>.</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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.Class</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/TemplateClassResolver.html#resolve-java.lang.String-freemarker.core.Environment-freemarker.template.Template-">resolve</a></span>(java.lang.String className, |
| <a href="../../freemarker/core/Environment.html" title="class in freemarker.core">Environment</a> env, |
| <a href="../../freemarker/template/Template.html" title="class in freemarker.template">Template</a> template)</code> |
| <div class="block">Gets a <code>Class</code> based on the class name.</div> |
| </td> |
| </tr> |
| </table> |
| </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="UNRESTRICTED_RESOLVER"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>UNRESTRICTED_RESOLVER</h4> |
| <pre>static final <a href="../../freemarker/core/TemplateClassResolver.html" title="interface in freemarker.core">TemplateClassResolver</a> UNRESTRICTED_RESOLVER</pre> |
| <div class="block">Simply calls <a href="../../freemarker/template/utility/ClassUtil.html#forName-java.lang.String-"><code>ClassUtil.forName(String)</code></a>.</div> |
| </li> |
| </ul> |
| <a name="SAFER_RESOLVER"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SAFER_RESOLVER</h4> |
| <pre>static final <a href="../../freemarker/core/TemplateClassResolver.html" title="interface in freemarker.core">TemplateClassResolver</a> SAFER_RESOLVER</pre> |
| <div class="block">Same as <a href="../../freemarker/core/TemplateClassResolver.html#UNRESTRICTED_RESOLVER"><code>UNRESTRICTED_RESOLVER</code></a>, except that it doesn't allow |
| resolving <a href="../../freemarker/template/utility/ObjectConstructor.html" title="class in freemarker.template.utility"><code>ObjectConstructor</code></a> and <a href="../../freemarker/template/utility/Execute.html" title="class in freemarker.template.utility"><code>Execute</code></a> and <code>freemarker.template.utility.JythonRuntime</code>.</div> |
| </li> |
| </ul> |
| <a name="ALLOWS_NOTHING_RESOLVER"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ALLOWS_NOTHING_RESOLVER</h4> |
| <pre>static final <a href="../../freemarker/core/TemplateClassResolver.html" title="interface in freemarker.core">TemplateClassResolver</a> ALLOWS_NOTHING_RESOLVER</pre> |
| <div class="block">Doesn't allow resolving any classes.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="resolve-java.lang.String-freemarker.core.Environment-freemarker.template.Template-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>resolve</h4> |
| <pre>java.lang.Class resolve(java.lang.String className, |
| <a href="../../freemarker/core/Environment.html" title="class in freemarker.core">Environment</a> env, |
| <a href="../../freemarker/template/Template.html" title="class in freemarker.template">Template</a> template) |
| throws <a href="../../freemarker/template/TemplateException.html" title="class in freemarker.template">TemplateException</a></pre> |
| <div class="block">Gets a <code>Class</code> based on the class name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>className</code> - the full-qualified class name</dd> |
| <dd><code>env</code> - the environment in which the template executes</dd> |
| <dd><code>template</code> - the template where the operation that require the |
| class resolution resides in. This is <code>null</code> if the |
| call doesn't come from a template.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../freemarker/template/TemplateException.html" title="class in freemarker.template">TemplateException</a></code> - if the class can't be found or shouldn't be |
| accessed from a template for security reasons.</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/TemplateClassResolver.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="../../freemarker/core/StopException.html" title="class in freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../freemarker/core/TemplateCombinedMarkupOutputModel.html" title="class in freemarker.core"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?freemarker/core/TemplateClassResolver.html" target="_top">Frames</a></li> |
| <li><a href="TemplateClassResolver.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>Constr | </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>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
