C D E G L O P R S T
All Classes All Packages

C

com.github.rvesse.airline.annotations.help.external - package com.github.rvesse.airline.annotations.help.external

com.github.rvesse.airline.help.external - module com.github.rvesse.airline.help.external

Copyright (C) 2010-16 the original author or authors.

com.github.rvesse.airline.help.external.factories - package com.github.rvesse.airline.help.external.factories

com.github.rvesse.airline.help.external.parsers - package com.github.rvesse.airline.help.external.parsers

com.github.rvesse.airline.help.external.parsers.defaults - package com.github.rvesse.airline.help.external.parsers.defaults

createSection(Annotation) - Method in class com.github.rvesse.airline.help.external.factories.ExternalHelpFactory

D

DefaultExternalHelpParser - Class in com.github.rvesse.airline.help.external.parsers.defaults

Default external help parser

DefaultExternalHelpParser() - Constructor for class com.github.rvesse.airline.help.external.parsers.defaults.DefaultExternalHelpParser

descriptionSource() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalExamples

Source containing the descriptions of the examples

E

exampleSource() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalExamples

Source containing the examples

ExternalDiscussion - Annotation Type in com.github.rvesse.airline.annotations.help.external

Defines a discussion section where the discussion content is provided in a text file on the classpath

ExternalExamples - Annotation Type in com.github.rvesse.airline.annotations.help.external

Annotation that provides an examples section for a commands help via two external resources in textual format

ExternalExitCodes - Annotation Type in com.github.rvesse.airline.annotations.help.external

Annotation that indicates the exit codes section for a commands help

ExternalHelpFactory - Class in com.github.rvesse.airline.help.external.factories

Help section factory that enables the additional annotations provided by this module

ExternalHelpFactory() - Constructor for class com.github.rvesse.airline.help.external.factories.ExternalHelpFactory

ExternalProse - Annotation Type in com.github.rvesse.airline.annotations.help.external

Defines a prose section where the prose content is provided in a text file on the classpath

ExternalTabularExamples - Annotation Type in com.github.rvesse.airline.annotations.help.external

Annotation that provides an examples section for a commands help via a single external resource in tabular format

G

getTabularFormat() - Method in class com.github.rvesse.airline.help.external.parsers.defaults.DefaultExternalHelpParser

Gets the tabular format in use for parsing tabular data

getTabularFormat() - Method in class com.github.rvesse.airline.help.external.parsers.defaults.TabDelimitedHelpParser

L

loadParagraphsParser(Class<? extends ParagraphsParser>) - Method in class com.github.rvesse.airline.help.external.factories.ExternalHelpFactory

Loads the paragraphs parser

loadTabularParser(Class<? extends TabularParser>) - Method in class com.github.rvesse.airline.help.external.factories.ExternalHelpFactory

Loads the tabular parser

O

openResource(ResourceLocator[], String) - Method in class com.github.rvesse.airline.help.external.factories.ExternalHelpFactory

Opens the specified resource using the first resource locator that is able to open it

P

ParagraphsParser - Interface in com.github.rvesse.airline.help.external.parsers

Parser that translates input into a series of paragraphs

parseParagraphs(ResourceLocator[], String, ParagraphsParser) - Method in class com.github.rvesse.airline.help.external.factories.ExternalHelpFactory

Parses paragraphs from a resource

parseParagraphs(String, InputStream) - Method in class com.github.rvesse.airline.help.external.parsers.defaults.DefaultExternalHelpParser

parseParagraphs(String, InputStream) - Method in interface com.github.rvesse.airline.help.external.parsers.ParagraphsParser

Parses input into a series of paragraphs

parser() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalDiscussion

The parser to use to translate the source specified by ExternalDiscussion.source() into paragraphs

parser() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalExamples

The parser to use to translate the source specified by ExternalExamples.exampleSource() and ExternalExamples.descriptionSource() into paragraphs

parser() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalExitCodes

The parser to use to translate the source specified by ExternalExitCodes.source() into paragraphs

parser() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalProse

The parser to use to translate the source specified by ExternalProse.source() into paragraphs

parser() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalTabularExamples

The parser to use to translate the source specified by ExternalTabularExamples.source() into tabular data

parseRows(String, InputStream) - Method in class com.github.rvesse.airline.help.external.parsers.defaults.DefaultExternalHelpParser

parseRows(String, InputStream) - Method in interface com.github.rvesse.airline.help.external.parsers.TabularParser

Parsers a list of rows from a resource

parseTabular(ResourceLocator[], String, TabularParser) - Method in class com.github.rvesse.airline.help.external.factories.ExternalHelpFactory

Parses tabular data from a resource

R

rowToArray(List<List<String>>, int) - Method in class com.github.rvesse.airline.help.external.factories.ExternalHelpFactory

Converts one column of a list of rows into an array

rowToNumericArray(List<List<String>>, int, String) - Method in class com.github.rvesse.airline.help.external.factories.ExternalHelpFactory

Converts one column of a list of rows into an array

S

source() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalDiscussion

Source containing the discussion content

source() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalExitCodes

Source containing the table of exit codes and their descriptions

source() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalProse

Source containing the prose content

source() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalTabularExamples

Source containing the examples and their descriptions in tabular format

sourceLocators() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalDiscussion

Resource locators used to find the resources specified in ExternalDiscussion.source()

sourceLocators() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalExamples

Resource locators used to find the resources specified in ExternalExamples.exampleSource() and ExternalExamples.descriptionSource()

sourceLocators() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalExitCodes

Resource locators used to find the resources specified in ExternalExitCodes.source()

sourceLocators() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalProse

Resource locators used to find the resources specified in ExternalProse.source()

sourceLocators() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalTabularExamples

Resource locators used to find the resources specified in ExternalTabularExamples.source()

suggestedOrder() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalProse

Suggested order in which the help section should be placed relative to other help sections

supportedAnnotations() - Method in class com.github.rvesse.airline.help.external.factories.ExternalHelpFactory

T

TabDelimitedHelpParser - Class in com.github.rvesse.airline.help.external.parsers.defaults

An external helper parser that parses tabular resources in Tab Delimited format

TabDelimitedHelpParser() - Constructor for class com.github.rvesse.airline.help.external.parsers.defaults.TabDelimitedHelpParser

TabularParser - Interface in com.github.rvesse.airline.help.external.parsers

title() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalProse

Title of the section

C D E G L O P R S T
All Classes All Packages