Class TroffPrinter

java.lang.Object

com.github.rvesse.airline.io.printers.TroffPrinter

public class TroffPrinter
extends Object

Printer class for generating Troff output

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TroffPrinter.BulletStyle	Supported bullet style
private static enum	TroffPrinter.ListType

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	BULLET_STYLE_BULLET
private static final String	BULLET_STYLE_DASH
private static final String	BULLET_STYLE_EM_DASH
private static final int	DEFAULT_INDENTATION
private final int	indentation
private boolean	inSection
private int	level
private final String	listGlyph
private Stack<TroffPrinter.ListType>	lists
private boolean	newline
private static final String	REQUEST_BREAK
private static final String	REQUEST_FONT_BOLD
private static final String	REQUEST_FONT_BOLD_ITALIC
private static final String	REQUEST_FONT_ITALIC
private static final String	REQUEST_FONT_ROMAN
private static final String	REQUEST_MOVE_LEFT_MARGIN
private static final String	REQUEST_PARAGRAPH_CURRENT_INDENTATION
private static final String	REQUEST_PARAGRAPH_NO_INDENTATION
private static final String	REQUEST_PARAGRAPH_TITLED
private static final String	REQUEST_RESET_LEFT_MARGIN
private static final String	REQUEST_TABLE_END
private static final String	REQUEST_TABLE_START
private final PrintWriter	writer

Constructor Summary

Constructors

Constructor	Description
TroffPrinter(PrintWriter writer)
TroffPrinter(PrintWriter writer, int indentation, TroffPrinter.BulletStyle style)

Method Summary

Modifier and Type	Method	Description
private void	appendLine(String line)
private String	asArg(String arg)
void	endList()
private String	escape(String line)
private String	escapeArg(String arg)
void	finish()
void	flush()
void	lineBreak()
void	nextBulletedListItem()
void	nextNumberedListItem()
void	nextPlainListItem()
void	nextSection(String sectionTitle)
void	nextTitledListItem()	Moves to the next titled list item without providing a title.
void	nextTitledListItem(String title)
protected void	notInList()
private void	prepareLine()
void	print(String value)
void	printBold(String value)
void	printBoldItalic(String value)
protected void	printBullet()
void	printItalic(String value)
void	println()
void	println(String value)
protected void	printNumberedBullet(boolean first)
protected void	printPlainBullet()
void	printTable(List<List<String>> rows, boolean hasHeader)
protected void	printTitledBullet()
void	start(String title, int manSection)
void	start(String title, int manSection, String header, String footer, String footerExtra)
void	startBulletedList()
void	startNumberedList()
void	startPlainList()
void	startTitledList()	Starts a titled list, the next line of text printed will form the title
void	startTitledList(String title)	Starts a titled list with the given title

Methods inherited from class Object

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

Field Details

REQUEST_TABLE_END

private static final String REQUEST_TABLE_END

See Also:

• Constant Field Values

REQUEST_TABLE_START

private static final String REQUEST_TABLE_START

See Also:

• Constant Field Values

REQUEST_FONT_ROMAN

private static final String REQUEST_FONT_ROMAN

See Also:

• Constant Field Values

REQUEST_FONT_BOLD

private static final String REQUEST_FONT_BOLD

See Also:

• Constant Field Values

REQUEST_FONT_ITALIC

private static final String REQUEST_FONT_ITALIC

See Also:

• Constant Field Values

REQUEST_FONT_BOLD_ITALIC

private static final String REQUEST_FONT_BOLD_ITALIC

See Also:

• Constant Field Values

REQUEST_PARAGRAPH_TITLED

private static final String REQUEST_PARAGRAPH_TITLED

See Also:

• Constant Field Values

REQUEST_PARAGRAPH_CURRENT_INDENTATION

private static final String REQUEST_PARAGRAPH_CURRENT_INDENTATION

See Also:

• Constant Field Values

REQUEST_PARAGRAPH_NO_INDENTATION

private static final String REQUEST_PARAGRAPH_NO_INDENTATION

See Also:

• Constant Field Values

REQUEST_RESET_LEFT_MARGIN

private static final String REQUEST_RESET_LEFT_MARGIN

See Also:

• Constant Field Values

REQUEST_MOVE_LEFT_MARGIN

private static final String REQUEST_MOVE_LEFT_MARGIN

See Also:

• Constant Field Values

REQUEST_BREAK

private static final String REQUEST_BREAK

See Also:

• Constant Field Values

BULLET_STYLE_BULLET

private static final String BULLET_STYLE_BULLET

See Also:

• Constant Field Values

BULLET_STYLE_DASH

private static final String BULLET_STYLE_DASH

See Also:

• Constant Field Values

BULLET_STYLE_EM_DASH

private static final String BULLET_STYLE_EM_DASH

See Also:

• Constant Field Values

DEFAULT_INDENTATION

private static final int DEFAULT_INDENTATION

See Also:

• Constant Field Values

writer

private final PrintWriter writer

level

private int level

newline

private boolean newline

inSection

private boolean inSection

indentation

private final int indentation

See Also:

• Constant Field Values

lists

private Stack<TroffPrinter.ListType> lists

listGlyph

private final String listGlyph

Constructor Details

TroffPrinter

public TroffPrinter(PrintWriter writer)

TroffPrinter

public TroffPrinter(PrintWriter writer,
 int indentation,
 TroffPrinter.BulletStyle style)

Method Details

start

public void start(String title,
 int manSection)

start

public void start(String title,
 int manSection,
 String header,
 String footer,
 String footerExtra)

nextSection

public void nextSection(String sectionTitle)

print

public void print(String value)

println

public void println(String value)

println

public void println()

lineBreak

public void lineBreak()

printBold

public void printBold(String value)

printItalic

public void printItalic(String value)

printBoldItalic

public void printBoldItalic(String value)

appendLine

private void appendLine(String line)

startBulletedList

public void startBulletedList()

startPlainList

public void startPlainList()

startNumberedList

public void startNumberedList()

startTitledList

public void startTitledList()

Starts a titled list, the next line of text printed will form the title

startTitledList

public void startTitledList(String title)

Starts a titled list with the given title

Parameters:

title -

nextBulletedListItem

public void nextBulletedListItem()

nextPlainListItem

public void nextPlainListItem()

notInList

protected void notInList()

nextNumberedListItem

public void nextNumberedListItem()

nextTitledListItem

public void nextTitledListItem()

Moves to the next titled list item without providing a title. The next line of text written will therefore be treated as the title for this item.

nextTitledListItem

public void nextTitledListItem(String title)

endList

public void endList()

printTable

public void printTable(List<List<String>> rows,
 boolean hasHeader)

prepareLine

private void prepareLine()

printBullet

protected void printBullet()

printTitledBullet

protected void printTitledBullet()

printPlainBullet

protected void printPlainBullet()

printNumberedBullet

protected void printNumberedBullet(boolean first)

asArg

private String asArg(String arg)

escapeArg

private String escapeArg(String arg)

escape

private String escape(String line)

flush

public void flush()

finish

public void finish()