public enum HelpFormat extends Enum<HelpFormat>
HelpSection
or HelpHint
may
provide this but help generators are not obliged to follow thisEnum Constant and Description |
---|
EXAMPLES
Help format is examples, the first content block is the examples and the
subsequent content block(s) are explanations for the examples
|
LIST
Help format is a list, each content block represents a separate list
|
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
|
PROSE
Help format is prose i.e.
|
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
|
UNKNOWN
Help format is unknown
|
Modifier and Type | Method and Description |
---|---|
static HelpFormat |
valueOf(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.
|
public static final HelpFormat UNKNOWN
public static final HelpFormat PROSE
public static final HelpFormat LIST
public static final HelpFormat TABLE
public static final HelpFormat TABLE_WITH_HEADERS
public static final HelpFormat EXAMPLES
public static final HelpFormat NONE_PRINTABLE
public static HelpFormat[] values()
for (HelpFormat c : HelpFormat.values()) System.out.println(c);
public static HelpFormat valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant
with the specified nameNullPointerException
- if the argument is nullCopyright © 2012–2017. All rights reserved.