Module com.github.rvesse.airline.help.external

Package com.github.rvesse.airline.help.external.parsers.defaults

Class DefaultExternalHelpParser

java.lang.Object

com.github.rvesse.airline.help.external.parsers.defaults.DefaultExternalHelpParser

All Implemented Interfaces:

ParagraphsParser, TabularParser

Direct Known Subclasses:

TabDelimitedHelpParser

public class DefaultExternalHelpParser
extends Object
implements ParagraphsParser, TabularParser

Default external help parser

Constructor Summary

Constructors

Constructor	Description
DefaultExternalHelpParser()

Method Summary

Modifier and Type	Method	Description
protected org.apache.commons.csv.CSVFormat	getTabularFormat()	Gets the tabular format in use for parsing tabular data
String[]	parseParagraphs(String resource, InputStream input)	Parses input into a series of paragraphs
List<List<String>>	parseRows(String resource, InputStream input)	Parsers a list of rows from a resource

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultExternalHelpParser

public DefaultExternalHelpParser()

Method Detail

parseParagraphs

public String[] parseParagraphs(String resource,
                                InputStream input)

Description copied from interface: ParagraphsParser

Parses input into a series of paragraphs

Specified by:

parseParagraphs in interface ParagraphsParser

Parameters:

resource - Resource name

input - Input

Returns:

Paragraphs

getTabularFormat

protected org.apache.commons.csv.CSVFormat getTabularFormat()

Gets the tabular format in use for parsing tabular data

Returns:

Tabular Format

parseRows

public List<List<String>> parseRows(String resource,
                                    InputStream input)

Description copied from interface: TabularParser

Parsers a list of rows from a resource

Specified by:

parseRows in interface TabularParser

Returns:

List of rows