- java.lang.Object
-
- java.lang.Enum<HelpFormat>
-
- com.github.rvesse.airline.help.sections.HelpFormat
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<HelpFormat>
public enum HelpFormat extends java.lang.Enum<HelpFormat>
Enumeration of help formats, aHelpSection
orHelpHint
may provide this but help generators are not obliged to follow this
-
-
Enum Constant Summary
Enum Constants Enum Constant Description EXAMPLES
Help format is examples, the first content block is the examples and the subsequent content block(s) are explanations for the examplesLIST
Help format is a list, each content block represents a separate listNONE_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 wayPROSE
Help format is prose i.e.TABLE
Help format is a table, each content block will represent a column of the tableTABLE_WITH_HEADERS
Help format is a table where headers are included as the first item of each columnUNKNOWN
Help format is unknown
-
Constructor Summary
Constructors Modifier Constructor Description private
HelpFormat()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static HelpFormat
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static HelpFormat[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
UNKNOWN
public static final HelpFormat UNKNOWN
Help format is unknown
-
PROSE
public static final HelpFormat PROSE
Help format is prose i.e. paragraphs of text, each content block is a set of paragraphs
-
LIST
public static final HelpFormat LIST
Help format is a list, each content block represents a separate list
-
TABLE
public static final HelpFormat TABLE
Help format is a table, each content block will represent a column of the table
-
TABLE_WITH_HEADERS
public static final HelpFormat TABLE_WITH_HEADERS
Help format is a table where headers are included as the first item of each column
-
EXAMPLES
public static final HelpFormat 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
public static final HelpFormat 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
-
-
Method Detail
-
values
public static HelpFormat[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (HelpFormat c : HelpFormat.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static HelpFormat valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
-