Module com.github.rvesse.airline
Enum Class HelpFormat
- All Implemented Interfaces:
Serializable
,Comparable<HelpFormat>
,Constable
Enumeration of help formats, a
HelpSection
or HelpHint
may
provide this but help generators are not obliged to follow this-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionHelp format is examples, the first content block is the examples and the subsequent content block(s) are explanations for the examplesHelp format is a list, each content block represents a separate listHelp represents some non-printable format, this can be used to create special sections that carry extra data that is used by help generators in some other wayHelp format is prose i.e.Help format is a table, each content block will represent a column of the tableHelp format is a table where headers are included as the first item of each columnHelp format is unknown -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic HelpFormat
Returns the enum constant of this class with the specified name.static HelpFormat[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
UNKNOWN
Help format is unknown -
PROSE
Help format is prose i.e. paragraphs of text, each content block is a set of paragraphs -
LIST
Help format is a list, each content block represents a separate list -
TABLE
Help format is a table, each content block will represent a column of the table -
TABLE_WITH_HEADERS
Help format is a table where headers are included as the first item of each column -
EXAMPLES
Help format is examples, the first content block is the examples and the subsequent content block(s) are explanations for the examples -
NONE_PRINTABLE
Help represents some non-printable format, this can be used to create special sections that carry extra data that is used by help generators in some other way
-
-
Constructor Details
-
HelpFormat
private HelpFormat()
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-