Module com.github.rvesse.airline.io

Package com.github.rvesse.airline.io.printers

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

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)
static String	trimEnd(String str)

Methods inherited from class java.lang.Object

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

Constructor Detail

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 Detail

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()