openbook.tools.converter

Class PlainTokenRenderer

java.lang.Object

openbook.tools.converter.PlainTokenRenderer

All Implemented Interfaces:

TokenRenderer

public class PlainTokenRenderer
extends Object
implements TokenRenderer

A default implementation of TokenRenderer that simply prints the token.

Author:

Pinaki Poddar

Constructor Summary

Constructors

Constructor and Description
PlainTokenRenderer()

Method Summary

Methods

Modifier and Type	Method and Description
String	endLine(int line) Produce a string to signal end of a line.
String	getEpilogue() Gets a string to be added after token processing ends.
String	getLineNumberFormat()
String	getPrologue() Gets a string to be added before token processing begins.
boolean	getShowLineNumber()
String	newLine(int line) Produce a string to signal beginning of a line.
String	render(int decision, org.antlr.runtime.Token token) Produce a string representation of the given token.
void	setLineNumberFormat(String lineNumberFormat)
void	setShowLineNumber(boolean showLineNumber)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PlainTokenRenderer

public PlainTokenRenderer()

Method Detail

endLine

public String endLine(int line)

Description copied from interface: TokenRenderer

Produce a string to signal end of a line.
For example, a renderer can produce a newline.

Specified by:

endLine in interface TokenRenderer

Parameters:

line - the line being ended

Returns:

a String can be a blank

newLine

public String newLine(int line)

Description copied from interface: TokenRenderer

Produce a string to signal beginning of a line.
For example, a renderer printing line numbers can produce a String with the given line number.

Specified by:

newLine in interface TokenRenderer

Parameters:

line - the current line number

Returns:

a String can be a blank

render

public String render(int decision,
            org.antlr.runtime.Token token)

Description copied from interface: TokenRenderer

Produce a string representation of the given token.

Specified by:

render in interface TokenRenderer

Parameters:

decision - the index of the decision (or the context) in which the current token is being processed. The index refers to ANTLR DebugEventListener.enterDecision(int).

token - the token to be rendered. Can be a hidden token as well.

Returns:

a string representation of the given token.

getEpilogue

public String getEpilogue()

Description copied from interface: TokenRenderer

Gets a string to be added after token processing ends. For example, a HTML renderer may return the closing HTML and BODY tags.

Specified by:

getEpilogue in interface TokenRenderer

getPrologue

public String getPrologue()

Description copied from interface: TokenRenderer

Gets a string to be added before token processing begins.
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 tag to include the style sheet.

Specified by:

getPrologue in interface TokenRenderer

getShowLineNumber

public boolean getShowLineNumber()

setShowLineNumber

public void setShowLineNumber(boolean showLineNumber)

getLineNumberFormat

public String getLineNumberFormat()

Returns:

the lineNumberFormat

setLineNumberFormat

public void setLineNumberFormat(String lineNumberFormat)

Parameters:

lineNumberFormat - the lineNumberFormat to set