http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/28940aad/builds/fm2.3.28/api/freemarker/core/ParserConfiguration.html ---------------------------------------------------------------------- diff --git a/builds/fm2.3.28/api/freemarker/core/ParserConfiguration.html b/builds/fm2.3.28/api/freemarker/core/ParserConfiguration.html new file mode 100644 index 0000000..f47a8f8 --- /dev/null +++ b/builds/fm2.3.28/api/freemarker/core/ParserConfiguration.html @@ -0,0 +1,384 @@ +<!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_144) on Sat Mar 10 20:54:57 CET 2018 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ParserConfiguration (FreeMarker 2.3.28-nightly_20180310T195428Z-incubating API)</title> +<meta name="date" content="2018-03-10"> +<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="ParserConfiguration (FreeMarker 2.3.28-nightly_20180310T195428Z-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":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/ParserConfiguration.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/ParseException.html" title="class in freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../freemarker/core/ParsingNotSupportedException.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/ParserConfiguration.html" target="_top">Frames</a></li> +<li><a href="ParserConfiguration.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>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<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 ParserConfiguration" class="title">Interface ParserConfiguration</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/template/Configuration.html" title="class in freemarker.template">Configuration</a>, <a href="../../freemarker/core/TemplateConfiguration.html" title="class in freemarker.core">TemplateConfiguration</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">ParserConfiguration</span></pre> +<div class="block"><b>Don't implement this interface yourself</b>; use the existing implementation(s). This interface is implemented by + classes that hold settings that affect parsing. New parser settings can be added in new FreeMarker versions, which + will break your implementation.</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"> +<!-- ========== 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><a href="../../freemarker/core/ArithmeticEngine.html" title="class in freemarker.core">ArithmeticEngine</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/ParserConfiguration.html#getArithmeticEngine--">getArithmeticEngine</a></span>()</code> +<div class="block">Overlaps with <a href="../../freemarker/core/Configurable.html#getArithmeticEngine--"><code>Configurable.getArithmeticEngine()</code></a>; the parser needs this for creating numerical literals.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/ParserConfiguration.html#getAutoEscapingPolicy--">getAutoEscapingPolicy</a></span>()</code> +<div class="block">See <a href="../../freemarker/template/Configuration.html#getAutoEscapingPolicy--"><code>Configuration.getAutoEscapingPolicy()</code></a>.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../freemarker/template/Version.html" title="class in freemarker.template">Version</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/ParserConfiguration.html#getIncompatibleImprovements--">getIncompatibleImprovements</a></span>()</code> +<div class="block">See <a href="../../freemarker/template/Configuration.html#getIncompatibleImprovements--"><code>Configuration.getIncompatibleImprovements()</code></a>.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/ParserConfiguration.html#getNamingConvention--">getNamingConvention</a></span>()</code> +<div class="block">See <a href="../../freemarker/template/Configuration.html#getNamingConvention--"><code>Configuration.getNamingConvention()</code></a>.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../freemarker/core/OutputFormat.html" title="class in freemarker.core">OutputFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/ParserConfiguration.html#getOutputFormat--">getOutputFormat</a></span>()</code> +<div class="block">See <a href="../../freemarker/core/Configurable.html#getOutputEncoding--"><code>Configurable.getOutputEncoding()</code></a>.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/ParserConfiguration.html#getRecognizeStandardFileExtensions--">getRecognizeStandardFileExtensions</a></span>()</code> +<div class="block">See <a href="../../freemarker/template/Configuration.html#getRecognizeStandardFileExtensions--"><code>Configuration.getRecognizeStandardFileExtensions()</code></a>.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/ParserConfiguration.html#getStrictSyntaxMode--">getStrictSyntaxMode</a></span>()</code> +<div class="block">See <a href="../../freemarker/template/Configuration.html#getStrictSyntaxMode--"><code>Configuration.getStrictSyntaxMode()</code></a>.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/ParserConfiguration.html#getTabSize--">getTabSize</a></span>()</code> +<div class="block">See <a href="../../freemarker/template/Configuration.html#getTabSize--"><code>Configuration.getTabSize()</code></a>.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/ParserConfiguration.html#getTagSyntax--">getTagSyntax</a></span>()</code> +<div class="block">See <a href="../../freemarker/template/Configuration.html#getTagSyntax--"><code>Configuration.getTagSyntax()</code></a>.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/ParserConfiguration.html#getWhitespaceStripping--">getWhitespaceStripping</a></span>()</code> +<div class="block">See <a href="../../freemarker/template/Configuration.html#getWhitespaceStripping--"><code>Configuration.getWhitespaceStripping()</code></a>.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getTagSyntax--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTagSyntax</h4> +<pre>int getTagSyntax()</pre> +<div class="block">See <a href="../../freemarker/template/Configuration.html#getTagSyntax--"><code>Configuration.getTagSyntax()</code></a>.</div> +</li> +</ul> +<a name="getNamingConvention--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNamingConvention</h4> +<pre>int getNamingConvention()</pre> +<div class="block">See <a href="../../freemarker/template/Configuration.html#getNamingConvention--"><code>Configuration.getNamingConvention()</code></a>.</div> +</li> +</ul> +<a name="getWhitespaceStripping--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWhitespaceStripping</h4> +<pre>boolean getWhitespaceStripping()</pre> +<div class="block">See <a href="../../freemarker/template/Configuration.html#getWhitespaceStripping--"><code>Configuration.getWhitespaceStripping()</code></a>.</div> +</li> +</ul> +<a name="getArithmeticEngine--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getArithmeticEngine</h4> +<pre><a href="../../freemarker/core/ArithmeticEngine.html" title="class in freemarker.core">ArithmeticEngine</a> getArithmeticEngine()</pre> +<div class="block">Overlaps with <a href="../../freemarker/core/Configurable.html#getArithmeticEngine--"><code>Configurable.getArithmeticEngine()</code></a>; the parser needs this for creating numerical literals.</div> +</li> +</ul> +<a name="getStrictSyntaxMode--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStrictSyntaxMode</h4> +<pre>boolean getStrictSyntaxMode()</pre> +<div class="block">See <a href="../../freemarker/template/Configuration.html#getStrictSyntaxMode--"><code>Configuration.getStrictSyntaxMode()</code></a>.</div> +</li> +</ul> +<a name="getAutoEscapingPolicy--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAutoEscapingPolicy</h4> +<pre>int getAutoEscapingPolicy()</pre> +<div class="block">See <a href="../../freemarker/template/Configuration.html#getAutoEscapingPolicy--"><code>Configuration.getAutoEscapingPolicy()</code></a>.</div> +</li> +</ul> +<a name="getOutputFormat--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOutputFormat</h4> +<pre><a href="../../freemarker/core/OutputFormat.html" title="class in freemarker.core">OutputFormat</a> getOutputFormat()</pre> +<div class="block">See <a href="../../freemarker/core/Configurable.html#getOutputEncoding--"><code>Configurable.getOutputEncoding()</code></a>.</div> +</li> +</ul> +<a name="getRecognizeStandardFileExtensions--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRecognizeStandardFileExtensions</h4> +<pre>boolean getRecognizeStandardFileExtensions()</pre> +<div class="block">See <a href="../../freemarker/template/Configuration.html#getRecognizeStandardFileExtensions--"><code>Configuration.getRecognizeStandardFileExtensions()</code></a>.</div> +</li> +</ul> +<a name="getIncompatibleImprovements--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIncompatibleImprovements</h4> +<pre><a href="../../freemarker/template/Version.html" title="class in freemarker.template">Version</a> getIncompatibleImprovements()</pre> +<div class="block">See <a href="../../freemarker/template/Configuration.html#getIncompatibleImprovements--"><code>Configuration.getIncompatibleImprovements()</code></a>.</div> +</li> +</ul> +<a name="getTabSize--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getTabSize</h4> +<pre>int getTabSize()</pre> +<div class="block">See <a href="../../freemarker/template/Configuration.html#getTabSize--"><code>Configuration.getTabSize()</code></a>.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.25</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/ParserConfiguration.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/ParseException.html" title="class in freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../freemarker/core/ParsingNotSupportedException.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/ParserConfiguration.html" target="_top">Frames</a></li> +<li><a href="ParserConfiguration.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>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<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/28940aad/builds/fm2.3.28/api/freemarker/core/ParsingNotSupportedException.html ---------------------------------------------------------------------- diff --git a/builds/fm2.3.28/api/freemarker/core/ParsingNotSupportedException.html b/builds/fm2.3.28/api/freemarker/core/ParsingNotSupportedException.html new file mode 100644 index 0000000..085784c --- /dev/null +++ b/builds/fm2.3.28/api/freemarker/core/ParsingNotSupportedException.html @@ -0,0 +1,285 @@ +<!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_144) on Sat Mar 10 20:54:57 CET 2018 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ParsingNotSupportedException (FreeMarker 2.3.28-nightly_20180310T195428Z-incubating API)</title> +<meta name="date" content="2018-03-10"> +<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="ParsingNotSupportedException (FreeMarker 2.3.28-nightly_20180310T195428Z-incubating API)"; + } + } + catch(err) { + } +//--> +</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/ParsingNotSupportedException.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/ParserConfiguration.html" title="interface in freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../freemarker/core/PlainTextOutputFormat.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/ParsingNotSupportedException.html" target="_top">Frames</a></li> +<li><a href="ParsingNotSupportedException.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>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#methods.inherited.from.class.java.lang.Throwable">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li>Method</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 ParsingNotSupportedException" class="title">Class ParsingNotSupportedException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li><a href="../../freemarker/core/TemplateValueFormatException.html" title="class in freemarker.core">freemarker.core.TemplateValueFormatException</a></li> +<li> +<ul class="inheritance"> +<li>freemarker.core.ParsingNotSupportedException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">ParsingNotSupportedException</span> +extends <a href="../../freemarker/core/TemplateValueFormatException.html" title="class in freemarker.core">TemplateValueFormatException</a></pre> +<div class="block">Thrown when the <a href="../../freemarker/core/TemplateValueFormat.html" title="class in freemarker.core"><code>TemplateValueFormat</code></a> doesn't support parsing, and parsing was invoked.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.24</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../serialized-form.html#freemarker.core.ParsingNotSupportedException">Serialized Form</a></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"> </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/ParsingNotSupportedException.html#ParsingNotSupportedException-java.lang.String-">ParsingNotSupportedException</a></span>(java.lang.String message)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/core/ParsingNotSupportedException.html#ParsingNotSupportedException-java.lang.String-java.lang.Throwable-">ParsingNotSupportedException</a></span>(java.lang.String message, + java.lang.Throwable cause)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="ParsingNotSupportedException-java.lang.String-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ParsingNotSupportedException</h4> +<pre>public ParsingNotSupportedException(java.lang.String message, + java.lang.Throwable cause)</pre> +</li> +</ul> +<a name="ParsingNotSupportedException-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ParsingNotSupportedException</h4> +<pre>public ParsingNotSupportedException(java.lang.String message)</pre> +</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/ParsingNotSupportedException.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/ParserConfiguration.html" title="interface in freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../freemarker/core/PlainTextOutputFormat.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/ParsingNotSupportedException.html" target="_top">Frames</a></li> +<li><a href="ParsingNotSupportedException.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>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#methods.inherited.from.class.java.lang.Throwable">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li>Method</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/28940aad/builds/fm2.3.28/api/freemarker/core/PlainTextOutputFormat.html ---------------------------------------------------------------------- diff --git a/builds/fm2.3.28/api/freemarker/core/PlainTextOutputFormat.html b/builds/fm2.3.28/api/freemarker/core/PlainTextOutputFormat.html new file mode 100644 index 0000000..4e2ac89 --- /dev/null +++ b/builds/fm2.3.28/api/freemarker/core/PlainTextOutputFormat.html @@ -0,0 +1,360 @@ +<!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_144) on Sat Mar 10 20:54:57 CET 2018 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>PlainTextOutputFormat (FreeMarker 2.3.28-nightly_20180310T195428Z-incubating API)</title> +<meta name="date" content="2018-03-10"> +<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="PlainTextOutputFormat (FreeMarker 2.3.28-nightly_20180310T195428Z-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":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/PlainTextOutputFormat.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/ParsingNotSupportedException.html" title="class in freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../freemarker/core/RTFOutputFormat.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/PlainTextOutputFormat.html" target="_top">Frames</a></li> +<li><a href="PlainTextOutputFormat.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="Class PlainTextOutputFormat" class="title">Class PlainTextOutputFormat</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../freemarker/core/OutputFormat.html" title="class in freemarker.core">freemarker.core.OutputFormat</a></li> +<li> +<ul class="inheritance"> +<li>freemarker.core.PlainTextOutputFormat</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <span class="typeNameLabel">PlainTextOutputFormat</span> +extends <a href="../../freemarker/core/OutputFormat.html" title="class in freemarker.core">OutputFormat</a></pre> +<div class="block">Represents the plain text output format (MIME type "text/plain", name "plainText"). This format doesn't support + escaping. This format doesn't allow mixing in template output values of other output formats. + + <p> + The main difference from <a href="../../freemarker/core/UndefinedOutputFormat.html" title="class in freemarker.core"><code>UndefinedOutputFormat</code></a> is that this format doesn't allow inserting values of another + output format into itself (unless they can be converted to plain text), while <a href="../../freemarker/core/UndefinedOutputFormat.html" title="class in freemarker.core"><code>UndefinedOutputFormat</code></a> would + just insert the foreign "markup" as is. Also, this format has {"text/plain"} MIME type, while + <a href="../../freemarker/core/UndefinedOutputFormat.html" title="class in freemarker.core"><code>UndefinedOutputFormat</code></a> has <code>null</code>.</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"> +<!-- =========== 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/PlainTextOutputFormat.html" title="class in freemarker.core">PlainTextOutputFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/PlainTextOutputFormat.html#INSTANCE">INSTANCE</a></span></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/PlainTextOutputFormat.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>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/PlainTextOutputFormat.html#getName--">getName</a></span>()</code> +<div class="block">The short name 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>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/PlainTextOutputFormat.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> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.freemarker.core.OutputFormat"> +<!-- --> +</a> +<h3>Methods inherited from class freemarker.core.<a href="../../freemarker/core/OutputFormat.html" title="class in freemarker.core">OutputFormat</a></h3> +<code><a href="../../freemarker/core/OutputFormat.html#toString--">toString</a>, <a href="../../freemarker/core/OutputFormat.html#toStringExtraProperties--">toStringExtraProperties</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="INSTANCE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>INSTANCE</h4> +<pre>public static final <a href="../../freemarker/core/PlainTextOutputFormat.html" title="class in freemarker.core">PlainTextOutputFormat</a> INSTANCE</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="isOutputFormatMixingAllowed--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isOutputFormatMixingAllowed</h4> +<pre>public boolean isOutputFormatMixingAllowed()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../freemarker/core/OutputFormat.html#isOutputFormatMixingAllowed--">OutputFormat</a></code></span></div> +<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 to allow, as such an event 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 non-escaping, in + which case format conversion is trivially possible. (It's not impossible that conversions will be extended beyond + this, if there will be demand for that.) + + <p> + <code>true</code> value is used by <a href="../../freemarker/core/UndefinedOutputFormat.html" title="class in freemarker.core"><code>UndefinedOutputFormat</code></a>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../freemarker/core/OutputFormat.html#isOutputFormatMixingAllowed--">isOutputFormatMixingAllowed</a></code> in class <code><a href="../../freemarker/core/OutputFormat.html" title="class in freemarker.core">OutputFormat</a></code></dd> +</dl> +</li> +</ul> +<a name="getName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public java.lang.String getName()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../freemarker/core/OutputFormat.html#getName--">OutputFormat</a></code></span></div> +<div class="block">The short name used to refer to this format (like in the <code>#ftl</code> header).</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../freemarker/core/OutputFormat.html#getName--">getName</a></code> in class <code><a href="../../freemarker/core/OutputFormat.html" title="class in freemarker.core">OutputFormat</a></code></dd> +</dl> +</li> +</ul> +<a name="getMimeType--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getMimeType</h4> +<pre>public java.lang.String getMimeType()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../freemarker/core/OutputFormat.html#getMimeType--">OutputFormat</a></code></span></div> +<div class="block">Returns the MIME type of the output format. This might comes handy when generating a HTTP response. <code>null</code> + <code>null</code> if this output format doesn't clearly corresponds to a specific MIME type.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../freemarker/core/OutputFormat.html#getMimeType--">getMimeType</a></code> in class <code><a href="../../freemarker/core/OutputFormat.html" title="class in freemarker.core">OutputFormat</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/PlainTextOutputFormat.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/ParsingNotSupportedException.html" title="class in freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../freemarker/core/RTFOutputFormat.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/PlainTextOutputFormat.html" target="_top">Frames</a></li> +<li><a href="PlainTextOutputFormat.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> http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/28940aad/builds/fm2.3.28/api/freemarker/core/RTFOutputFormat.html ---------------------------------------------------------------------- diff --git a/builds/fm2.3.28/api/freemarker/core/RTFOutputFormat.html b/builds/fm2.3.28/api/freemarker/core/RTFOutputFormat.html new file mode 100644 index 0000000..2804e04 --- /dev/null +++ b/builds/fm2.3.28/api/freemarker/core/RTFOutputFormat.html @@ -0,0 +1,443 @@ +<!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_144) on Sat Mar 10 20:54:57 CET 2018 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>RTFOutputFormat (FreeMarker 2.3.28-nightly_20180310T195428Z-incubating API)</title> +<meta name="date" content="2018-03-10"> +<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="RTFOutputFormat (FreeMarker 2.3.28-nightly_20180310T195428Z-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":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/RTFOutputFormat.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/PlainTextOutputFormat.html" title="class in freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../freemarker/core/StopException.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/RTFOutputFormat.html" target="_top">Frames</a></li> +<li><a href="RTFOutputFormat.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="Class RTFOutputFormat" class="title">Class RTFOutputFormat</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../freemarker/core/OutputFormat.html" title="class in freemarker.core">freemarker.core.OutputFormat</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../freemarker/core/MarkupOutputFormat.html" title="class in freemarker.core">freemarker.core.MarkupOutputFormat</a><MO></li> +<li> +<ul class="inheritance"> +<li><a href="../../freemarker/core/CommonMarkupOutputFormat.html" title="class in freemarker.core">freemarker.core.CommonMarkupOutputFormat</a><<a href="../../freemarker/core/TemplateRTFOutputModel.html" title="class in freemarker.core">TemplateRTFOutputModel</a>></li> +<li> +<ul class="inheritance"> +<li>freemarker.core.RTFOutputFormat</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <span class="typeNameLabel">RTFOutputFormat</span> +extends <a href="../../freemarker/core/CommonMarkupOutputFormat.html" title="class in freemarker.core">CommonMarkupOutputFormat</a><<a href="../../freemarker/core/TemplateRTFOutputModel.html" title="class in freemarker.core">TemplateRTFOutputModel</a>></pre> +<div class="block">Represents the Rich Text Format output format (MIME type "application/rtf", name "RTF"). This format escapes by + default (via <a href="../../freemarker/template/utility/StringUtil.html#RTFEnc-java.lang.String-"><code>StringUtil.RTFEnc(String)</code></a>). The <code>?rtf</code> built-in silently bypasses template output values + of the type produced by this output format (<a href="../../freemarker/core/TemplateRTFOutputModel.html" title="class in freemarker.core"><code>TemplateRTFOutputModel</code></a>).</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"> +<!-- =========== 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/RTFOutputFormat.html" title="class in freemarker.core">RTFOutputFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/RTFOutputFormat.html#INSTANCE">INSTANCE</a></span></code> +<div class="block">The only instance (singleton) of this <a href="../../freemarker/core/OutputFormat.html" title="class in freemarker.core"><code>OutputFormat</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="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>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/RTFOutputFormat.html#escapePlainText-java.lang.String-">escapePlainText</a></span>(java.lang.String plainTextContent)</code> +<div class="block">Should give the same result as <a href="../../freemarker/core/MarkupOutputFormat.html#fromPlainTextByEscaping-java.lang.String-"><code>MarkupOutputFormat.fromPlainTextByEscaping(String)</code></a> and then + <a href="../../freemarker/core/MarkupOutputFormat.html#getMarkupString-MO-"><code>MarkupOutputFormat.getMarkupString(TemplateMarkupOutputModel)</code></a>, but the implementation may uses a more efficient solution.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/RTFOutputFormat.html#getMimeType--">getMimeType</a></span>()</code> +<div class="block">Returns the MIME type of the output format.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/RTFOutputFormat.html#getName--">getName</a></span>()</code> +<div class="block">The short name used to refer to this format (like in the <code>#ftl</code> header).</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/RTFOutputFormat.html#isLegacyBuiltInBypassed-java.lang.String-">isLegacyBuiltInBypassed</a></span>(java.lang.String builtInName)</code> +<div class="block">Tells if a string built-in that can't handle a <a href="../../freemarker/core/TemplateMarkupOutputModel.html" title="interface in freemarker.core"><code>TemplateMarkupOutputModel</code></a> left hand operand can bypass + this object as is.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>protected <a href="../../freemarker/core/TemplateRTFOutputModel.html" title="class in freemarker.core">TemplateRTFOutputModel</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/RTFOutputFormat.html#newTemplateMarkupOutputModel-java.lang.String-java.lang.String-">newTemplateMarkupOutputModel</a></span>(java.lang.String plainTextContent, + java.lang.String markupContent)</code> +<div class="block">Creates a new <a href="../../freemarker/core/CommonTemplateMarkupOutputModel.html" title="class in freemarker.core"><code>CommonTemplateMarkupOutputModel</code></a> that's bound to this <a href="../../freemarker/core/OutputFormat.html" title="class in freemarker.core"><code>OutputFormat</code></a> instance.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/RTFOutputFormat.html#output-java.lang.String-java.io.Writer-">output</a></span>(java.lang.String textToEsc, + java.io.Writer out)</code> +<div class="block">Equivalent to calling <a href="../../freemarker/core/MarkupOutputFormat.html#fromPlainTextByEscaping-java.lang.String-"><code>MarkupOutputFormat.fromPlainTextByEscaping(String)</code></a> and then + <a href="../../freemarker/core/MarkupOutputFormat.html#output-MO-java.io.Writer-"><code>MarkupOutputFormat.output(TemplateMarkupOutputModel, Writer)</code></a>, but the implementation may uses a more efficient solution.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.freemarker.core.CommonMarkupOutputFormat"> +<!-- --> +</a> +<h3>Methods inherited from class freemarker.core.<a href="../../freemarker/core/CommonMarkupOutputFormat.html" title="class in freemarker.core">CommonMarkupOutputFormat</a></h3> +<code><a href="../../freemarker/core/CommonMarkupOutputFormat.html#concat-MO-MO-">concat</a>, <a href="../../freemarker/core/CommonMarkupOutputFormat.html#fromMarkup-java.lang.String-">fromMarkup</a>, <a href="../../freemarker/core/CommonMarkupOutputFormat.html#fromPlainTextByEscaping-java.lang.String-">fromPlainTextByEscaping</a>, <a href="../../freemarker/core/CommonMarkupOutputFormat.html#getMarkupString-MO-">getMarkupString</a>, <a href="../../freemarker/core/CommonMarkupOutputFormat.html#getSourcePlainText-MO-">getSourcePlainText</a>, <a href="../../freemarker/core/CommonMarkupOutputFormat.html#isAutoEscapedByDefault--">isAutoEscapedByDefault</a>, <a href="../../freemarker/core/CommonMarkupOutputFormat.html#isEmpty-MO-">isEmpty</a>, <a href="../../freemarker/core/CommonMarkupOutputFormat.html#isOutputFormatMixingAllowed--">isOutputFormatMixingAllowed</a>, <a href="../../freemarker/core/CommonMarkupOutputFormat.html#output-MO-java.io.Writer-">output</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.freemarker.core.OutputFormat"> +<!-- --> +</a> +<h3>Methods inherited from class freemarker.core.<a href="../../freemarker/core/OutputFormat.html" title="class in freemarker.core">OutputFormat</a></h3> +<code><a href="../../freemarker/core/OutputFormat.html#toString--">toString</a>, <a href="../../freemarker/core/OutputFormat.html#toStringExtraProperties--">toStringExtraProperties</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="INSTANCE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>INSTANCE</h4> +<pre>public static final <a href="../../freemarker/core/RTFOutputFormat.html" title="class in freemarker.core">RTFOutputFormat</a> INSTANCE</pre> +<div class="block">The only instance (singleton) of this <a href="../../freemarker/core/OutputFormat.html" title="class in freemarker.core"><code>OutputFormat</code></a>.</div> +</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 java.lang.String getName()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../freemarker/core/OutputFormat.html#getName--">OutputFormat</a></code></span></div> +<div class="block">The short name used to refer to this format (like in the <code>#ftl</code> header).</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../freemarker/core/OutputFormat.html#getName--">getName</a></code> in class <code><a href="../../freemarker/core/OutputFormat.html" title="class in freemarker.core">OutputFormat</a></code></dd> +</dl> +</li> +</ul> +<a name="getMimeType--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMimeType</h4> +<pre>public java.lang.String getMimeType()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../freemarker/core/OutputFormat.html#getMimeType--">OutputFormat</a></code></span></div> +<div class="block">Returns the MIME type of the output format. This might comes handy when generating a HTTP response. <code>null</code> + <code>null</code> if this output format doesn't clearly corresponds to a specific MIME type.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../freemarker/core/OutputFormat.html#getMimeType--">getMimeType</a></code> in class <code><a href="../../freemarker/core/OutputFormat.html" title="class in freemarker.core">OutputFormat</a></code></dd> +</dl> +</li> +</ul> +<a name="output-java.lang.String-java.io.Writer-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>output</h4> +<pre>public void output(java.lang.String textToEsc, + java.io.Writer out) + throws java.io.IOException, + <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../freemarker/core/MarkupOutputFormat.html#output-java.lang.String-java.io.Writer-">MarkupOutputFormat</a></code></span></div> +<div class="block">Equivalent to calling <a href="../../freemarker/core/MarkupOutputFormat.html#fromPlainTextByEscaping-java.lang.String-"><code>MarkupOutputFormat.fromPlainTextByEscaping(String)</code></a> and then + <a href="../../freemarker/core/MarkupOutputFormat.html#output-MO-java.io.Writer-"><code>MarkupOutputFormat.output(TemplateMarkupOutputModel, Writer)</code></a>, but the implementation may uses a more efficient solution.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../freemarker/core/CommonMarkupOutputFormat.html#output-java.lang.String-java.io.Writer-">output</a></code> in class <code><a href="../../freemarker/core/CommonMarkupOutputFormat.html" title="class in freemarker.core">CommonMarkupOutputFormat</a><<a href="../../freemarker/core/TemplateRTFOutputModel.html" title="class in freemarker.core">TemplateRTFOutputModel</a>></code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +<dd><code><a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></code></dd> +</dl> +</li> +</ul> +<a name="escapePlainText-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>escapePlainText</h4> +<pre>public java.lang.String escapePlainText(java.lang.String plainTextContent)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../freemarker/core/MarkupOutputFormat.html#escapePlainText-java.lang.String-">MarkupOutputFormat</a></code></span></div> +<div class="block">Should give the same result as <a href="../../freemarker/core/MarkupOutputFormat.html#fromPlainTextByEscaping-java.lang.String-"><code>MarkupOutputFormat.fromPlainTextByEscaping(String)</code></a> and then + <a href="../../freemarker/core/MarkupOutputFormat.html#getMarkupString-MO-"><code>MarkupOutputFormat.getMarkupString(TemplateMarkupOutputModel)</code></a>, but the implementation may uses a more efficient solution.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../freemarker/core/MarkupOutputFormat.html#escapePlainText-java.lang.String-">escapePlainText</a></code> in class <code><a href="../../freemarker/core/MarkupOutputFormat.html" title="class in freemarker.core">MarkupOutputFormat</a><<a href="../../freemarker/core/TemplateRTFOutputModel.html" title="class in freemarker.core">TemplateRTFOutputModel</a>></code></dd> +</dl> +</li> +</ul> +<a name="isLegacyBuiltInBypassed-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isLegacyBuiltInBypassed</h4> +<pre>public boolean isLegacyBuiltInBypassed(java.lang.String builtInName)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../freemarker/core/MarkupOutputFormat.html#isLegacyBuiltInBypassed-java.lang.String-">MarkupOutputFormat</a></code></span></div> +<div class="block">Tells if a string built-in that can't handle a <a href="../../freemarker/core/TemplateMarkupOutputModel.html" title="interface in freemarker.core"><code>TemplateMarkupOutputModel</code></a> left hand operand can bypass + this object as is. A typical such case would be when a <a href="../../freemarker/core/TemplateHTMLOutputModel.html" title="class in freemarker.core"><code>TemplateHTMLOutputModel</code></a> of "HTML" format bypasses + <code>?html</code>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../freemarker/core/MarkupOutputFormat.html#isLegacyBuiltInBypassed-java.lang.String-">isLegacyBuiltInBypassed</a></code> in class <code><a href="../../freemarker/core/MarkupOutputFormat.html" title="class in freemarker.core">MarkupOutputFormat</a><<a href="../../freemarker/core/TemplateRTFOutputModel.html" title="class in freemarker.core">TemplateRTFOutputModel</a>></code></dd> +</dl> +</li> +</ul> +<a name="newTemplateMarkupOutputModel-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>newTemplateMarkupOutputModel</h4> +<pre>protected <a href="../../freemarker/core/TemplateRTFOutputModel.html" title="class in freemarker.core">TemplateRTFOutputModel</a> newTemplateMarkupOutputModel(java.lang.String plainTextContent, + java.lang.String markupContent)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../freemarker/core/CommonMarkupOutputFormat.html#newTemplateMarkupOutputModel-java.lang.String-java.lang.String-">CommonMarkupOutputFormat</a></code></span></div> +<div class="block">Creates a new <a href="../../freemarker/core/CommonTemplateMarkupOutputModel.html" title="class in freemarker.core"><code>CommonTemplateMarkupOutputModel</code></a> that's bound to this <a href="../../freemarker/core/OutputFormat.html" title="class in freemarker.core"><code>OutputFormat</code></a> instance.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../freemarker/core/CommonMarkupOutputFormat.html#newTemplateMarkupOutputModel-java.lang.String-java.lang.String-">newTemplateMarkupOutputModel</a></code> in class <code><a href="../../freemarker/core/CommonMarkupOutputFormat.html" title="class in freemarker.core">CommonMarkupOutputFormat</a><<a href="../../freemarker/core/TemplateRTFOutputModel.html" title="class in freemarker.core">TemplateRTFOutputModel</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/RTFOutputFormat.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/PlainTextOutputFormat.html" title="class in freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../freemarker/core/StopException.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/RTFOutputFormat.html" target="_top">Frames</a></li> +<li><a href="RTFOutputFormat.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> http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/28940aad/builds/fm2.3.28/api/freemarker/core/StopException.html ---------------------------------------------------------------------- diff --git a/builds/fm2.3.28/api/freemarker/core/StopException.html b/builds/fm2.3.28/api/freemarker/core/StopException.html new file mode 100644 index 0000000..08ad762 --- /dev/null +++ b/builds/fm2.3.28/api/freemarker/core/StopException.html @@ -0,0 +1,305 @@ +<!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_144) on Sat Mar 10 20:54:57 CET 2018 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>StopException (FreeMarker 2.3.28-nightly_20180310T195428Z-incubating API)</title> +<meta name="date" content="2018-03-10"> +<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="StopException (FreeMarker 2.3.28-nightly_20180310T195428Z-incubating 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/StopException.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/RTFOutputFormat.html" title="class in freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../freemarker/core/TemplateClassResolver.html" title="interface in freemarker.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?freemarker/core/StopException.html" target="_top">Frames</a></li> +<li><a href="StopException.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>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<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 StopException" class="title">Class StopException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li><a href="../../freemarker/template/TemplateException.html" title="class in freemarker.template">freemarker.template.TemplateException</a></li> +<li> +<ul class="inheritance"> +<li>freemarker.core.StopException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">StopException</span> +extends <a href="../../freemarker/template/TemplateException.html" title="class in freemarker.template">TemplateException</a></pre> +<div class="block">This exception is thrown when a <tt>#stop</tt> directive is encountered.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../serialized-form.html#freemarker.core.StopException">Serialized Form</a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/StopException.html#printStackTrace-java.io.PrintStream-">printStackTrace</a></span>(java.io.PrintStream ps)</code> +<div class="block">Overrides <code>Throwable.printStackTrace(PrintStream)</code> so that it will include the FTL stack trace.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/StopException.html#printStackTrace-java.io.PrintWriter-">printStackTrace</a></span>(java.io.PrintWriter pw)</code> +<div class="block">Overrides <code>Throwable.printStackTrace(PrintWriter)</code> so that it will include the FTL stack trace.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.freemarker.template.TemplateException"> +<!-- --> +</a> +<h3>Methods inherited from class freemarker.template.<a href="../../freemarker/template/TemplateException.html" title="class in freemarker.template">TemplateException</a></h3> +<code><a href="../../freemarker/template/TemplateException.html#getBlamedExpressionString--">getBlamedExpressionString</a>, <a href="../../freemarker/template/TemplateException.html#getCauseException--">getCauseException</a>, <a href="../../freemarker/template/TemplateException.html#getColumnNumber--">getColumnNumber</a>, <a href="../../freemarker/template/TemplateException.html#getEndColumnNumber--">getEndColumnNumber</a>, <a href="../../freemarker/template/TemplateException.html#getEndLineNumber--">getEndLineNumber</a>, <a href="../../freemarker/template/TemplateException.html#getEnvironment--">getEnvironment</a>, <a href="../../freemarker/template/TemplateException.html#getFTLInstructionStack--">getFTLInstructionStack</a>, <a href="../../freemarker/template/TemplateException.html#getLineNumber--">getLineNumber</a>, <a href="../../freemarker/template/TemplateException.html#getMessage--">getMessage</a>, <a href="../../freemarker/template/TemplateException.html#getMessageWithoutStac kTop--">getMessageWithoutStackTop</a>, <a href="../../freemarker/template/TemplateException.html#getTemplateName--">getTemplateName</a>, <a href="../../freemarker/template/TemplateException.html#getTemplateSourceName--">getTemplateSourceName</a>, <a href="../../freemarker/template/TemplateException.html#printStackTrace-java.io.PrintStream-boolean-boolean-boolean-">printStackTrace</a>, <a href="../../freemarker/template/TemplateException.html#printStackTrace-java.io.PrintWriter-boolean-boolean-boolean-">printStackTrace</a>, <a href="../../freemarker/template/TemplateException.html#printStandardStackTrace-java.io.PrintStream-">printStandardStackTrace</a>, <a href="../../freemarker/template/TemplateException.html#printStandardStackTrace-java.io.PrintWriter-">printStandardStackTrace</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, setStackTrace, toString</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="printStackTrace-java.io.PrintWriter-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printStackTrace</h4> +<pre>public void printStackTrace(java.io.PrintWriter pw)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../freemarker/template/TemplateException.html#printStackTrace-java.io.PrintWriter-">TemplateException</a></code></span></div> +<div class="block">Overrides <code>Throwable.printStackTrace(PrintWriter)</code> so that it will include the FTL stack trace.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../freemarker/template/TemplateException.html#printStackTrace-java.io.PrintWriter-">printStackTrace</a></code> in class <code><a href="../../freemarker/template/TemplateException.html" title="class in freemarker.template">TemplateException</a></code></dd> +</dl> +</li> +</ul> +<a name="printStackTrace-java.io.PrintStream-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>printStackTrace</h4> +<pre>public void printStackTrace(java.io.PrintStream ps)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../freemarker/template/TemplateException.html#printStackTrace-java.io.PrintStream-">TemplateException</a></code></span></div> +<div class="block">Overrides <code>Throwable.printStackTrace(PrintStream)</code> so that it will include the FTL stack trace.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../freemarker/template/TemplateException.html#printStackTrace-java.io.PrintStream-">printStackTrace</a></code> in class <code><a href="../../freemarker/template/TemplateException.html" title="class in freemarker.template">TemplateException</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/StopException.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/RTFOutputFormat.html" title="class in freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../freemarker/core/TemplateClassResolver.html" title="interface in freemarker.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?freemarker/core/StopException.html" target="_top">Frames</a></li> +<li><a href="StopException.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>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
