java.lang.Object
java.lang.Enum<HelpFormat>
com.github.rvesse.airline.help.sections.HelpFormat
All Implemented Interfaces:
Serializable, Comparable<HelpFormat>, Constable

public enum HelpFormat extends Enum<HelpFormat>
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 Constants
    Enum Constant
    Description
    Help format is examples, the first content block is the examples and the subsequent content block(s) are explanations for the examples
    Help format is a list, each content block represents a separate list
    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
    Help format is prose i.e.
    Help format is a table, each content block will represent a column of the table
    Help format is a table where headers are included as the first item of each column
    Help format is unknown
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
     
  • Method Summary

    Modifier and Type
    Method
    Description
    static HelpFormat
    Returns the enum constant of this class with the specified name.
    static HelpFormat[]
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • 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
  • Constructor Details

    • HelpFormat

      private HelpFormat()
  • Method Details

    • values

      public static HelpFormat[] 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

      public static HelpFormat valueOf(String name)
      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 name
      NullPointerException - if the argument is null