Class UsagePrinter

java.lang.Object

com.github.rvesse.airline.io.printers.UsagePrinter

public class UsagePrinter
extends Object

Helper for printing out usage information

Provides support for maintaining indents and wrapping text to a column width

Field Summary

Fields

Modifier and Type	Field	Description
private final AtomicInteger	currentPosition
private final int	hangingIndent
private final int	indent
private final int	maxSize
private final PrintWriter	out

Constructor Summary

Constructors

Constructor	Description
UsagePrinter(PrintWriter out)
UsagePrinter(PrintWriter out, int maxSize)
UsagePrinter(PrintWriter out, int maxSize, int indent, int hangingIndent, AtomicInteger currentPosition)

Method Summary

Modifier and Type	Method	Description
UsagePrinter	append(String value)
UsagePrinter	append(String value, boolean avoidNewlines)
UsagePrinter	appendLines(Iterable<String> lines)
UsagePrinter	appendLines(Iterable<String> lines, boolean avoidNewlines)
UsagePrinter	appendOnOneLine(String value)
UsagePrinter	appendTable(Iterable<? extends Iterable<String>> table, int rowSpacing)
UsagePrinter	appendWords(Iterable<String> words)
UsagePrinter	appendWords(Iterable<String> words, boolean avoidNewlines)
UsagePrinter	appendWords(String[] words)
UsagePrinter	appendWords(String[] words, boolean avoidNewlines)
void	close()
void	flush()
UsagePrinter	newIndentedPrinter(int size)
UsagePrinter	newline()
UsagePrinter	newPrinterWithHangingIndent(int size)
private static String	spaces(int count)
static String	trimEnd(String str)

Methods inherited from class Object

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

Field Details

out

private final PrintWriter out

maxSize

private final int maxSize

indent

private final int indent

hangingIndent

private final int hangingIndent

currentPosition

private final AtomicInteger currentPosition

Constructor Details

UsagePrinter

public UsagePrinter(PrintWriter out)

UsagePrinter

public UsagePrinter(PrintWriter out,
 int maxSize)

UsagePrinter

public UsagePrinter(PrintWriter out,
 int maxSize,
 int indent,
 int hangingIndent,
 AtomicInteger currentPosition)

Method Details

newIndentedPrinter

public UsagePrinter newIndentedPrinter(int size)

newPrinterWithHangingIndent

public UsagePrinter newPrinterWithHangingIndent(int size)

newline

public UsagePrinter newline()

appendTable

public UsagePrinter appendTable(Iterable<? extends Iterable<String>> table,
 int rowSpacing)

trimEnd

public static String trimEnd(String str)

append

public UsagePrinter append(String value)

appendOnOneLine

public UsagePrinter appendOnOneLine(String value)

appendWords

public UsagePrinter appendWords(String[] words)

appendWords

public UsagePrinter appendWords(Iterable<String> words)

append

public UsagePrinter append(String value,
 boolean avoidNewlines)

appendLines

public UsagePrinter appendLines(Iterable<String> lines)

appendLines

public UsagePrinter appendLines(Iterable<String> lines,
 boolean avoidNewlines)

appendWords

public UsagePrinter appendWords(String[] words,
 boolean avoidNewlines)

appendWords

public UsagePrinter appendWords(Iterable<String> words,
 boolean avoidNewlines)

flush

public void flush()

close

public void close()

spaces

private static String spaces(int count)