blob: 5f0f2d690e1baea980944445a9e479814b3154d4 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="it">
<head>
<!-- Generated by javadoc (version 1.7.0_80) on Thu Jun 14 10:04:10 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TokenRenderer (OpenJPA Parent POM 2.4.3 API)</title>
<meta name="date" content="2018-06-14">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="TokenRenderer (OpenJPA Parent POM 2.4.3 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/TokenRenderer.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="../../../openbook/tools/converter/SourceRenderer.html" title="class in openbook.tools.converter"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?openbook/tools/converter/TokenRenderer.html" target="_top">Frames</a></li>
<li><a href="TokenRenderer.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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">openbook.tools.converter</div>
<h2 title="Interface TokenRenderer" class="title">Interface TokenRenderer</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../openbook/tools/converter/HTMLTokenRenderer.html" title="class in openbook.tools.converter">HTMLTokenRenderer</a>, <a href="../../../openbook/tools/converter/PlainTokenRenderer.html" title="class in openbook.tools.converter">PlainTokenRenderer</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">TokenRenderer</span></pre>
<div class="block">Renders a runtime ANTLR token.
<a href="../../../openbook/tools/converter/ParseTokenListener.html" title="class in openbook.tools.converter">ParseTokenListener</a> controls a renderer and streams the rendered Strings
to appropriate output.
<br>
A renderer can define additional bean-style setter methods. They will be set before
renderer is used.
<br>
A concrete renderer should have a no argument constructor.
<br>
<a href="../../../openbook/tools/converter/ParseTokenListener.html" title="class in openbook.tools.converter">ParseTokenListener</a> or the <em>framework</em> calls a renderer in following sequence:
<pre>
bean-style setter methods as per the user configured
getPrologue()
for each token {
if (line is changing) {
endLine()
newLine()
}
render()
}
getEpilogue();
</pre></div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Pinaki Poddar</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../openbook/tools/converter/TokenRenderer.html#endLine(int)">endLine</a></strong>(int&nbsp;line)</code>
<div class="block">Produce a string to signal end of a line.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../openbook/tools/converter/TokenRenderer.html#getEpilogue()">getEpilogue</a></strong>()</code>
<div class="block">Gets a string to be added after token processing ends.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../openbook/tools/converter/TokenRenderer.html#getPrologue()">getPrologue</a></strong>()</code>
<div class="block">Gets a string to be added before token processing begins.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../openbook/tools/converter/TokenRenderer.html#newLine(int)">newLine</a></strong>(int&nbsp;line)</code>
<div class="block">Produce a string to signal beginning of a line.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../openbook/tools/converter/TokenRenderer.html#render(int,%20org.antlr.runtime.Token)">render</a></strong>(int&nbsp;decision,
org.antlr.runtime.Token&nbsp;token)</code>
<div class="block">Produce a string representation of the given token.</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="getPrologue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPrologue</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getPrologue()</pre>
<div class="block">Gets a string to be added before token processing begins.
<br>
For example, a HTML renderer may return the opening HTML and BODY tags.
A HTML render using a Cascaded Style Sheet may additionally specify
the <HEAD> tag to include the style sheet.</div>
</li>
</ul>
<a name="getEpilogue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEpilogue</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getEpilogue()</pre>
<div class="block">Gets a string to be added after token processing ends.
For example, a HTML renderer may return the closing HTML and BODY tags.</div>
</li>
</ul>
<a name="render(int, org.antlr.runtime.Token)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>render</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;render(int&nbsp;decision,
org.antlr.runtime.Token&nbsp;token)</pre>
<div class="block">Produce a string representation of the given token.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>decision</code> - the index of the decision (or the context) in which
the current token is being processed. The index refers to ANTLR
<code>DebugEventListener.enterDecision(int)</code>.</dd><dd><code>token</code> - the token to be rendered. Can be a hidden token as well.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a string representation of the given token.</dd></dl>
</li>
</ul>
<a name="newLine(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newLine</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;newLine(int&nbsp;line)</pre>
<div class="block">Produce a string to signal beginning of a line.
<br>
For example, a renderer printing line numbers can produce a String with the given line number.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>line</code> - the current line number</dd>
<dt><span class="strong">Returns:</span></dt><dd>a String can be a blank</dd></dl>
</li>
</ul>
<a name="endLine(int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>endLine</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;endLine(int&nbsp;line)</pre>
<div class="block">Produce a string to signal end of a line.
<br>
For example, a renderer can produce a newline.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>line</code> - the line being ended</dd>
<dt><span class="strong">Returns:</span></dt><dd>a String can be a blank</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/TokenRenderer.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="../../../openbook/tools/converter/SourceRenderer.html" title="class in openbook.tools.converter"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?openbook/tools/converter/TokenRenderer.html" target="_top">Frames</a></li>
<li><a href="TokenRenderer.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2018 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>