Google Git
Sign in
apache / openjpa-site / f4f8b894b02554a0a851bbf380ef41d45c445062 / . / content / builds / 2.4.3 / apidocs / openbook / tools / converter / PlainTokenRenderer.html
blob: 44625feed253f6f690542f0785615435a34449ba [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>PlainTokenRenderer (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="PlainTokenRenderer (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/PlainTokenRenderer.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/ParseTokenListener.html" title="class in openbook.tools.converter"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../openbook/tools/converter/SourceRenderer.html" title="class in openbook.tools.converter"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?openbook/tools/converter/PlainTokenRenderer.html" target="_top">Frames</a></li>
<li><a href="PlainTokenRenderer.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><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">openbook.tools.converter</div>
<h2 title="Class PlainTokenRenderer" class="title">Class PlainTokenRenderer</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>openbook.tools.converter.PlainTokenRenderer</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../openbook/tools/converter/TokenRenderer.html" title="interface in openbook.tools.converter">TokenRenderer</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">PlainTokenRenderer</span>
extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../openbook/tools/converter/TokenRenderer.html" title="interface in openbook.tools.converter">TokenRenderer</a></pre>
<div class="block">A default implementation of <a href="../../../openbook/tools/converter/TokenRenderer.html" title="interface in openbook.tools.converter">TokenRenderer</a> that simply prints the token.</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">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../openbook/tools/converter/PlainTokenRenderer.html#PlainTokenRenderer()">PlainTokenRenderer</a></strong>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="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/PlainTokenRenderer.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/PlainTokenRenderer.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/PlainTokenRenderer.html#getLineNumberFormat()">getLineNumberFormat</a></strong>()</code>&nbsp;</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/PlainTokenRenderer.html#getPrologue()">getPrologue</a></strong>()</code>
<div class="block">Gets a string to be added before token processing begins.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../openbook/tools/converter/PlainTokenRenderer.html#getShowLineNumber()">getShowLineNumber</a></strong>()</code>&nbsp;</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/PlainTokenRenderer.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/PlainTokenRenderer.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>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../openbook/tools/converter/PlainTokenRenderer.html#setLineNumberFormat(java.lang.String)">setLineNumberFormat</a></strong>(<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;lineNumberFormat)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../openbook/tools/converter/PlainTokenRenderer.html#setShowLineNumber(boolean)">setShowLineNumber</a></strong>(boolean&nbsp;showLineNumber)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="PlainTokenRenderer()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PlainTokenRenderer</h4>
<pre>public&nbsp;PlainTokenRenderer()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="endLine(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>endLine</h4>
<pre>public&nbsp;<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"><strong>Description copied from interface:&nbsp;<code><a href="../../../openbook/tools/converter/TokenRenderer.html#endLine(int)">TokenRenderer</a></code></strong></div>
<div class="block">Produce a string to signal end of a line.
<br>
For example, a renderer can produce a newline.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../openbook/tools/converter/TokenRenderer.html#endLine(int)">endLine</a></code>&nbsp;in interface&nbsp;<code><a href="../../../openbook/tools/converter/TokenRenderer.html" title="interface in openbook.tools.converter">TokenRenderer</a></code></dd>
<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>
<a name="newLine(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newLine</h4>
<pre>public&nbsp;<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"><strong>Description copied from interface:&nbsp;<code><a href="../../../openbook/tools/converter/TokenRenderer.html#newLine(int)">TokenRenderer</a></code></strong></div>
<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><strong>Specified by:</strong></dt>
<dd><code><a href="../../../openbook/tools/converter/TokenRenderer.html#newLine(int)">newLine</a></code>&nbsp;in interface&nbsp;<code><a href="../../../openbook/tools/converter/TokenRenderer.html" title="interface in openbook.tools.converter">TokenRenderer</a></code></dd>
<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="render(int, org.antlr.runtime.Token)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>render</h4>
<pre>public&nbsp;<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"><strong>Description copied from interface:&nbsp;<code><a href="../../../openbook/tools/converter/TokenRenderer.html#render(int,%20org.antlr.runtime.Token)">TokenRenderer</a></code></strong></div>
<div class="block">Produce a string representation of the given token.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../openbook/tools/converter/TokenRenderer.html#render(int,%20org.antlr.runtime.Token)">render</a></code>&nbsp;in interface&nbsp;<code><a href="../../../openbook/tools/converter/TokenRenderer.html" title="interface in openbook.tools.converter">TokenRenderer</a></code></dd>
<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="getEpilogue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEpilogue</h4>
<pre>public&nbsp;<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"><strong>Description copied from interface:&nbsp;<code><a href="../../../openbook/tools/converter/TokenRenderer.html#getEpilogue()">TokenRenderer</a></code></strong></div>
<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>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../openbook/tools/converter/TokenRenderer.html#getEpilogue()">getEpilogue</a></code>&nbsp;in interface&nbsp;<code><a href="../../../openbook/tools/converter/TokenRenderer.html" title="interface in openbook.tools.converter">TokenRenderer</a></code></dd>
</dl>
</li>
</ul>
<a name="getPrologue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPrologue</h4>
<pre>public&nbsp;<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"><strong>Description copied from interface:&nbsp;<code><a href="../../../openbook/tools/converter/TokenRenderer.html#getPrologue()">TokenRenderer</a></code></strong></div>
<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>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../openbook/tools/converter/TokenRenderer.html#getPrologue()">getPrologue</a></code>&nbsp;in interface&nbsp;<code><a href="../../../openbook/tools/converter/TokenRenderer.html" title="interface in openbook.tools.converter">TokenRenderer</a></code></dd>
</dl>
</li>
</ul>
<a name="getShowLineNumber()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getShowLineNumber</h4>
<pre>public&nbsp;boolean&nbsp;getShowLineNumber()</pre>
</li>
</ul>
<a name="setShowLineNumber(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setShowLineNumber</h4>
<pre>public&nbsp;void&nbsp;setShowLineNumber(boolean&nbsp;showLineNumber)</pre>
</li>
</ul>
<a name="getLineNumberFormat()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLineNumberFormat</h4>
<pre>public&nbsp;<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;getLineNumberFormat()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>the lineNumberFormat</dd></dl>
</li>
</ul>
<a name="setLineNumberFormat(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setLineNumberFormat</h4>
<pre>public&nbsp;void&nbsp;setLineNumberFormat(<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;lineNumberFormat)</pre>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>lineNumberFormat</code> - the lineNumberFormat to set</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/PlainTokenRenderer.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/ParseTokenListener.html" title="class in openbook.tools.converter"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../openbook/tools/converter/SourceRenderer.html" title="class in openbook.tools.converter"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?openbook/tools/converter/PlainTokenRenderer.html" target="_top">Frames</a></li>
<li><a href="PlainTokenRenderer.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><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<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>