freemarker-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ddek...@apache.org
Subject [20/51] [partial] incubator-freemarker-site git commit: Uploaded freemarker.org/builds content from the previous (non-ASF) server
Date Tue, 03 Nov 2015 23:03:50 GMT
http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/b35e4aa5/builds/2.3.24-pre01/_html/api/freemarker/core/OptInTemplateClassResolver.html
----------------------------------------------------------------------
diff --git a/builds/2.3.24-pre01/_html/api/freemarker/core/OptInTemplateClassResolver.html
b/builds/2.3.24-pre01/_html/api/freemarker/core/OptInTemplateClassResolver.html
new file mode 100644
index 0000000..baf47f8
--- /dev/null
+++ b/builds/2.3.24-pre01/_html/api/freemarker/core/OptInTemplateClassResolver.html
@@ -0,0 +1,362 @@
+<!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_20) on Wed Sep 02 01:20:17 CEST 2015 -->
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>OptInTemplateClassResolver (FreeMarker 2.3.24-pre01 API)</title>
+<meta name="date" content="2015-09-02">
+<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="OptInTemplateClassResolver (FreeMarker 2.3.24-pre01 API)";
+        }
+    }
+    catch(err) {
+    }
+//-->
+var methods = {"i0":10,"i1":10};
+var tabs = {65535:["t0","All 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/OptInTemplateClassResolver.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/NonStringOrTemplateOutputException.html" title="class
in freemarker.core"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
+<li><a href="../../freemarker/core/OutputFormat.html" title="class in freemarker.core"><span
class="typeNameLink">Next&nbsp;Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../index.html?freemarker/core/OptInTemplateClassResolver.html" target="_top">Frames</a></li>
+<li><a href="OptInTemplateClassResolver.html" target="_top">No&nbsp;Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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="Class OptInTemplateClassResolver" class="title">Class OptInTemplateClassResolver</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li><a href="http://docs.oracle.com/javase/8/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>freemarker.core.OptInTemplateClassResolver</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd><a href="../../freemarker/core/TemplateClassResolver.html" title="interface
in freemarker.core">TemplateClassResolver</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public class <span class="typeNameLabel">OptInTemplateClassResolver</span>
+extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</a>
+implements <a href="../../freemarker/core/TemplateClassResolver.html" title="interface
in freemarker.core">TemplateClassResolver</a></pre>
+<div class="block">A <a href="../../freemarker/core/TemplateClassResolver.html"
title="interface in freemarker.core"><code>TemplateClassResolver</code></a>
that resolves only the classes whose name 
+ was specified in the constructor.</div>
+</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>
+<ul class="blockList">
+<li class="blockList"><a name="fields.inherited.from.class.freemarker.core.TemplateClassResolver">
+<!--   -->
+</a>
+<h3>Fields inherited from interface&nbsp;freemarker.core.<a href="../../freemarker/core/TemplateClassResolver.html"
title="interface in freemarker.core">TemplateClassResolver</a></h3>
+<code><a href="../../freemarker/core/TemplateClassResolver.html#ALLOWS_NOTHING_RESOLVER">ALLOWS_NOTHING_RESOLVER</a>,
<a href="../../freemarker/core/TemplateClassResolver.html#SAFER_RESOLVER">SAFER_RESOLVER</a>,
<a href="../../freemarker/core/TemplateClassResolver.html#UNRESTRICTED_RESOLVER">UNRESTRICTED_RESOLVER</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">&nbsp;</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="../../freemarker/core/OptInTemplateClassResolver.html#OptInTemplateClassResolver-java.util.Set-java.util.List-">OptInTemplateClassResolver</a></span>(<a
href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class
or interface in java.util">Set</a>&nbsp;allowedClasses,
+                          <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"
title="class or interface in java.util">List</a>&nbsp;trustedTemplates)</code>
+<div class="block">Creates a new instance.</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a
href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span
id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span
class="tabEnd">&nbsp;</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/8/docs/api/java/lang/Class.html?is-external=true"
title="class or interface in java.lang">Class</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/OptInTemplateClassResolver.html#resolve-java.lang.String-freemarker.core.Environment-freemarker.template.Template-">resolve</a></span>(<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class
or interface in java.lang">String</a>&nbsp;className,
+       <a href="../../freemarker/core/Environment.html" title="class in freemarker.core">Environment</a>&nbsp;env,
+       <a href="../../freemarker/template/Template.html" title="class in freemarker.template">Template</a>&nbsp;template)</code>
+<div class="block">Gets a <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"
title="class or interface in java.lang"><code>Class</code></a> based
on the class name.</div>
+</td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/8/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="../../freemarker/core/OptInTemplateClassResolver.html#safeGetTemplateName-freemarker.template.Template-">safeGetTemplateName</a></span>(<a
href="../../freemarker/template/Template.html" title="class in freemarker.template">Template</a>&nbsp;template)</code>
+<div class="block">Extract the template name from the template object which will be
matched
+ against the trusted template names and pattern.</div>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
+<!--   -->
+</a>
+<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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">
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor.detail">
+<!--   -->
+</a>
+<h3>Constructor Detail</h3>
+<a name="OptInTemplateClassResolver-java.util.Set-java.util.List-">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>OptInTemplateClassResolver</h4>
+<pre>public&nbsp;OptInTemplateClassResolver(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true"
title="class or interface in java.util">Set</a>&nbsp;allowedClasses,
+                                  <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"
title="class or interface in java.util">List</a>&nbsp;trustedTemplates)</pre>
+<div class="block">Creates a new instance.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>allowedClasses</code> - the <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true"
title="class or interface in java.util"><code>Set</code></a> of <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class
or interface in java.lang"><code>String</code></a>-s that contains
+     the full-qualified names of the allowed classes.
+     Can be <code>null</code> (means not class is allowed).</dd>
+<dd><code>trustedTemplates</code> - the <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"
title="class or interface in java.util"><code>List</code></a> of <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class
or interface in java.lang"><code>String</code></a>-s that contains
+     template names (i.e., template root directory relative paths)
+     and prefix patterns (like <code>"include/*"</code>) of templates
+     for which <a href="../../freemarker/core/TemplateClassResolver.html#SAFER_RESOLVER"><code>TemplateClassResolver.SAFER_RESOLVER</code></a>
will be 
+     used (which is not as safe as <a href="../../freemarker/core/OptInTemplateClassResolver.html"
title="class in freemarker.core"><code>OptInTemplateClassResolver</code></a>).
+     The list items need not start with <code>"/"</code> (if they are, it
+     will be removed). List items ending with <code>"*"</code> are treated
+     as prefixes (i.e. <code>"foo*"</code> matches <code>"foobar"</code>,
+     <code>"foo/bar/baaz"</code>, <code>"foowhatever/bar/baaz"</code>,
+     etc.). The <code>"*"</code> has no special meaning anywhere else.
+     The matched template name is the name (template root directory
+     relative path) of the template that directly (lexically) contains the
+     operation (like <code>?new</code>) that wants to get the class. Thus,
+     if a trusted template includes a non-trusted template, the
+     <code>allowedClasses</code> restriction will apply in the included
+     template.
+     This parameter can be <code>null</code> (means no trusted templates).</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="resolve-java.lang.String-freemarker.core.Environment-freemarker.template.Template-">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>resolve</h4>
+<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"
title="class or interface in java.lang">Class</a>&nbsp;resolve(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a>&nbsp;className,
+                     <a href="../../freemarker/core/Environment.html" title="class in
freemarker.core">Environment</a>&nbsp;env,
+                     <a href="../../freemarker/template/Template.html" title="class in
freemarker.template">Template</a>&nbsp;template)
+              throws <a href="../../freemarker/template/TemplateException.html" title="class
in freemarker.template">TemplateException</a></pre>
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a
href="../../freemarker/core/TemplateClassResolver.html#resolve-java.lang.String-freemarker.core.Environment-freemarker.template.Template-">TemplateClassResolver</a></code></span></div>
+<div class="block">Gets a <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"
title="class or interface in java.lang"><code>Class</code></a> based
on the class name.</div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../../freemarker/core/TemplateClassResolver.html#resolve-java.lang.String-freemarker.core.Environment-freemarker.template.Template-">resolve</a></code>&nbsp;in
interface&nbsp;<code><a href="../../freemarker/core/TemplateClassResolver.html"
title="interface in freemarker.core">TemplateClassResolver</a></code></dd>
+<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>
+<a name="safeGetTemplateName-freemarker.template.Template-">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>safeGetTemplateName</h4>
+<pre>protected&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a>&nbsp;safeGetTemplateName(<a
href="../../freemarker/template/Template.html" title="class in freemarker.template">Template</a>&nbsp;template)</pre>
+<div class="block">Extract the template name from the template object which will be
matched
+ against the trusted template names and pattern.</div>
+</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/OptInTemplateClassResolver.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/NonStringOrTemplateOutputException.html" title="class
in freemarker.core"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
+<li><a href="../../freemarker/core/OutputFormat.html" title="class in freemarker.core"><span
class="typeNameLink">Next&nbsp;Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../index.html?freemarker/core/OptInTemplateClassResolver.html" target="_top">Frames</a></li>
+<li><a href="OptInTemplateClassResolver.html" target="_top">No&nbsp;Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!--   -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>

http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/b35e4aa5/builds/2.3.24-pre01/_html/api/freemarker/core/OutputFormat.html
----------------------------------------------------------------------
diff --git a/builds/2.3.24-pre01/_html/api/freemarker/core/OutputFormat.html b/builds/2.3.24-pre01/_html/api/freemarker/core/OutputFormat.html
new file mode 100644
index 0000000..b43f2f1
--- /dev/null
+++ b/builds/2.3.24-pre01/_html/api/freemarker/core/OutputFormat.html
@@ -0,0 +1,366 @@
+<!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_20) on Wed Sep 02 01:20:17 CEST 2015 -->
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>OutputFormat (FreeMarker 2.3.24-pre01 API)</title>
+<meta name="date" content="2015-09-02">
+<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="OutputFormat (FreeMarker 2.3.24-pre01 API)";
+        }
+    }
+    catch(err) {
+    }
+//-->
+var methods = {"i0":6,"i1":6,"i2":6,"i3":10,"i4":10};
+var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/OutputFormat.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/OptInTemplateClassResolver.html" title="class
in freemarker.core"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
+<li><a href="../../freemarker/core/ParseException.html" title="class in freemarker.core"><span
class="typeNameLink">Next&nbsp;Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../index.html?freemarker/core/OutputFormat.html" target="_top">Frames</a></li>
+<li><a href="OutputFormat.html" target="_top">No&nbsp;Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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="Class OutputFormat" class="title">Class OutputFormat</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li><a href="http://docs.oracle.com/javase/8/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>freemarker.core.OutputFormat</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>Direct Known Subclasses:</dt>
+<dd><a href="../../freemarker/core/MarkupOutputFormat.html" title="class in freemarker.core">MarkupOutputFormat</a>,
<a href="../../freemarker/core/PlainTextOutputFormat.html" title="class in freemarker.core">PlainTextOutputFormat</a>,
<a href="../../freemarker/core/UndefinedOutputFormat.html" title="class in freemarker.core">UndefinedOutputFormat</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public abstract class <span class="typeNameLabel">OutputFormat</span>
+extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</a></pre>
+<div class="block">Encapsulates the <a href="../../freemarker/core/TemplateMarkupOutputModel.html"
title="interface in freemarker.core"><code>TemplateMarkupOutputModel</code></a>
factories and <code>TemplateOutputModel</code> operations, and other
+ meta information (like MIME type) about a certain output format.</div>
+<dl>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>2.3.24</dd>
+</dl>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ======== 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">&nbsp;</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="../../freemarker/core/OutputFormat.html#OutputFormat--">OutputFormat</a></span>()</code>&nbsp;</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a
href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span
id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span
class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a
href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>abstract <a href="http://docs.oracle.com/javase/8/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="../../freemarker/core/OutputFormat.html#getMimeType--">getMimeType</a></span>()</code>
+<div class="block">Returns the MIME type of the output format.</div>
+</td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code>abstract <a href="http://docs.oracle.com/javase/8/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="../../freemarker/core/OutputFormat.html#getName--">getName</a></span>()</code>
+<div class="block">The short name we used to refer to this format (like in the <code>#ftl</code>
header).</div>
+</td>
+</tr>
+<tr id="i2" class="altColor">
+<td class="colFirst"><code>abstract boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/OutputFormat.html#isOutputFormatMixingAllowed--">isOutputFormatMixingAllowed</a></span>()</code>
+<div class="block">Tells if this output format allows inserting <a href="../../freemarker/core/TemplateMarkupOutputModel.html"
title="interface in freemarker.core"><code>TemplateMarkupOutputModel</code></a>-s
of another output formats into it.</div>
+</td>
+</tr>
+<tr id="i3" class="rowColor">
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/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="../../freemarker/core/OutputFormat.html#toString--">toString</a></span>()</code>
+<div class="block">Returns the short description of this format, to be used in error
messages.</div>
+</td>
+</tr>
+<tr id="i4" class="altColor">
+<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/8/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="../../freemarker/core/OutputFormat.html#toStringExtraProperties--">toStringExtraProperties</a></span>()</code>
+<div class="block">Should be like <code>"foo=\"something\", bar=123"</code>;
this will be inserted inside the parentheses in
+ <a href="../../freemarker/core/OutputFormat.html#toString--"><code>toString()</code></a>.</div>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
+<!--   -->
+</a>
+<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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">
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor.detail">
+<!--   -->
+</a>
+<h3>Constructor Detail</h3>
+<a name="OutputFormat--">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>OutputFormat</h4>
+<pre>public&nbsp;OutputFormat()</pre>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.detail">
+<!--   -->
+</a>
+<h3>Method Detail</h3>
+<a name="getName--">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getName</h4>
+<pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a>&nbsp;getName()</pre>
+<div class="block">The short name we used to refer to this format (like in the <code>#ftl</code>
header).</div>
+</li>
+</ul>
+<a name="getMimeType--">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getMimeType</h4>
+<pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a>&nbsp;getMimeType()</pre>
+<div class="block">Returns the MIME type of the output format. This might comes handy
when generating generating a HTTP response.
+ <code>null</code> if the output format doesn't clearly corresponds to a specific
MIME type.</div>
+</li>
+</ul>
+<a name="isOutputFormatMixingAllowed--">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>isOutputFormatMixingAllowed</h4>
+<pre>public abstract&nbsp;boolean&nbsp;isOutputFormatMixingAllowed()</pre>
+<div class="block">Tells if this output format allows inserting <a href="../../freemarker/core/TemplateMarkupOutputModel.html"
title="interface in freemarker.core"><code>TemplateMarkupOutputModel</code></a>-s
of another output formats into it. If
+ <code>true</code>, the foreign <a href="../../freemarker/core/TemplateMarkupOutputModel.html"
title="interface in freemarker.core"><code>TemplateMarkupOutputModel</code></a>
will be inserted into the output as is (like if the
+ surrounding output format was the same). This is usually a bad idea, as such an even could
indicate application
+ bugs. If this method returns <code>false</code> (recommended), then FreeMarker
will try to assimilate the inserted
+ value by converting its format to this format, which will currently (2.3.24) cause exception,
unless the inserted
+ value is made by escaping plain text and the target format is not escaping, in which case
format conversion is
+ trivially possible. (It's not impossible to extending conversions beyond this, if there
will be real world demand
+ for it.)
+ 
+ <p><code>true</code> value is used by <a href="../../freemarker/core/UndefinedOutputFormat.html"
title="class in freemarker.core"><code>UndefinedOutputFormat</code></a>.</div>
+</li>
+</ul>
+<a name="toString--">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>toString</h4>
+<pre>public final&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a>&nbsp;toString()</pre>
+<div class="block">Returns the short description of this format, to be used in error
messages.
+ Override <a href="../../freemarker/core/OutputFormat.html#toStringExtraProperties--"><code>toStringExtraProperties()</code></a>
to customize this.</div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--"
title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class
or interface in java.lang">Object</a></code></dd>
+</dl>
+</li>
+</ul>
+<a name="toStringExtraProperties--">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>toStringExtraProperties</h4>
+<pre>protected&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a>&nbsp;toStringExtraProperties()</pre>
+<div class="block">Should be like <code>"foo=\"something\", bar=123"</code>;
this will be inserted inside the parentheses in
+ <a href="../../freemarker/core/OutputFormat.html#toString--"><code>toString()</code></a>.</div>
+</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/OutputFormat.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/OptInTemplateClassResolver.html" title="class
in freemarker.core"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
+<li><a href="../../freemarker/core/ParseException.html" title="class in freemarker.core"><span
class="typeNameLink">Next&nbsp;Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../index.html?freemarker/core/OutputFormat.html" target="_top">Frames</a></li>
+<li><a href="OutputFormat.html" target="_top">No&nbsp;Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!--   -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>



Mime
View raw message