Uses of Interface
com.github.rvesse.airline.help.sections.HelpHint
Packages that use HelpHint
Package
Description
-
Uses of HelpHint in com.github.rvesse.airline.examples.userguide.help.sections.custom
Classes in com.github.rvesse.airline.examples.userguide.help.sections.custom that implement HelpHint -
Uses of HelpHint in com.github.rvesse.airline.examples.userguide.restrictions.custom
Classes in com.github.rvesse.airline.examples.userguide.restrictions.custom that implement HelpHint -
Uses of HelpHint in com.github.rvesse.airline.help
Fields in com.github.rvesse.airline.help with type parameters of type HelpHintModifier and TypeFieldDescriptionstatic final Comparator
<HelpHint> UsageHelper.DEFAULT_HINT_COMPARATOR
Default comparator for help hints -
Uses of HelpHint in com.github.rvesse.airline.help.cli
Methods in com.github.rvesse.airline.help.cli with parameters of type HelpHintModifier and TypeMethodDescriptionstatic int
CliUsageHelper.calculateMaxRows
(HelpHint hint) protected void
CliUsageHelper.outputArgumentsRestriction
(UsagePrinter descriptionPrinter, ArgumentsMetadata arguments, ArgumentsRestriction restriction, HelpHint hint) Outputs documentation about a restriction on an optionprotected void
CliUsageHelper.outputHint
(UsagePrinter out, HelpHint hint, boolean newPara) protected void
CliUsageHelper.outputOptionRestriction
(UsagePrinter out, OptionMetadata option, OptionRestriction restriction, HelpHint hint) Outputs documentation about a restriction on an optionConstructor parameters in com.github.rvesse.airline.help.cli with type arguments of type HelpHintModifierConstructorDescriptionCliCommandGroupUsageGenerator
(int columns, boolean hideGlobalOptions, Comparator<? super HelpHint> hintComparator, Comparator<? super OptionMetadata> optionComparator, Comparator<? super CommandMetadata> commandComparator, boolean includeHidden) CliGlobalUsageGenerator
(int columnSize, Comparator<? super HelpHint> hintComparator, Comparator<? super OptionMetadata> optionComparator, Comparator<? super CommandMetadata> commandComparator, Comparator<? super CommandGroupMetadata> commandGroupComparator, boolean includeHidden) CliGlobalUsageSummaryGenerator
(int columnSize, Comparator<? super HelpHint> hintComparator, Comparator<? super OptionMetadata> optionComparator, Comparator<? super CommandMetadata> commandComparator, Comparator<? super CommandGroupMetadata> commandGroupComparator, boolean includeHidden) -
Uses of HelpHint in com.github.rvesse.airline.help.common
Fields in com.github.rvesse.airline.help.common with type parameters of type HelpHintModifier and TypeFieldDescriptionprivate final Comparator
<? super HelpHint> AbstractUsageGenerator.hintComparator
Methods in com.github.rvesse.airline.help.common that return types with arguments of type HelpHintModifier and TypeMethodDescriptionAbstractUsageGenerator.sortArgumentsRestrictions
(List<ArgumentsRestriction> restrictions) AbstractUsageGenerator.sortOptionRestrictions
(List<OptionRestriction> restrictions) Constructor parameters in com.github.rvesse.airline.help.common with type arguments of type HelpHintModifierConstructorDescriptionAbstractCommandGroupUsageGenerator
(Comparator<? super HelpHint> hintComparator, Comparator<? super OptionMetadata> optionComparator, Comparator<? super CommandMetadata> commandComparator, boolean includeHidden) AbstractCommandUsageGenerator
(Comparator<? super HelpHint> hintComparator, Comparator<? super OptionMetadata> optionComparator, Comparator<? super Map.Entry<Integer, String>> exitCodeComparator, boolean includeHidden) AbstractGlobalUsageGenerator
(Comparator<? super HelpHint> hintComparator, Comparator<? super OptionMetadata> optionComparator, Comparator<? super CommandMetadata> commandComparator, Comparator<? super CommandGroupMetadata> commandGroupComparator, boolean includeHidden) AbstractPrintedCommandGroupUsageGenerator
(int columnSize, Comparator<? super HelpHint> hintComparator, Comparator<? super OptionMetadata> optionComparator, Comparator<? super CommandMetadata> commandComparator, boolean includeHidden) AbstractPrintedGlobalUsageGenerator
(int columns, Comparator<? super HelpHint> hintComparator, Comparator<? super OptionMetadata> optionComparator, Comparator<? super CommandMetadata> commandComparator, Comparator<? super CommandGroupMetadata> commandGroupComparator, boolean includeHidden) AbstractUsageGenerator
(Comparator<? super HelpHint> hintComparator, Comparator<? super OptionMetadata> optionComparator, Comparator<? super CommandMetadata> commandComparator, boolean includeHidden) -
Uses of HelpHint in com.github.rvesse.airline.help.html
Methods in com.github.rvesse.airline.help.html with parameters of type HelpHintModifier and TypeMethodDescriptionprotected void
HtmlCommandUsageGenerator.outputHelpHint
(Writer writer, HelpHint hint) Outputs a help hintprotected void
HtmlCommandUsageGenerator.outputOptionRestriction
(Writer writer, OptionMetadata option, OptionRestriction restriction, HelpHint hint) Outputs a documentation section detailing an allowed value for an option -
Uses of HelpHint in com.github.rvesse.airline.help.man
Methods in com.github.rvesse.airline.help.man with parameters of type HelpHintModifier and TypeMethodDescriptionprotected void
ManUsageHelper.outputArgumentsRestriction
(TroffPrinter printer, ArgumentsMetadata arguments, ArgumentsRestriction restriction, HelpHint hint) Outputs documentation about a restriction on an optionprotected void
ManUsageHelper.outputHint
(TroffPrinter printer, HelpHint hint) protected void
ManUsageHelper.outputOptionRestriction
(TroffPrinter printer, OptionMetadata option, OptionRestriction restriction, HelpHint hint) Outputs documentation about a restriction on an option -
Uses of HelpHint in com.github.rvesse.airline.help.markdown
Methods in com.github.rvesse.airline.help.markdown with parameters of type HelpHintModifier and TypeMethodDescriptionstatic int
MarkdownUsageHelper.calculateMaxRows
(HelpHint hint) protected void
MarkdownUsageHelper.outputArgumentsRestriction
(UsagePrinter descriptionPrinter, ArgumentsMetadata arguments, ArgumentsRestriction restriction, HelpHint hint) Outputs documentation about a restriction on an optionprotected void
MarkdownUsageHelper.outputHint
(UsagePrinter out, HelpHint hint, boolean newPara) protected void
MarkdownUsageHelper.outputOptionRestriction
(UsagePrinter out, OptionMetadata option, OptionRestriction restriction, HelpHint hint) Outputs documentation about a restriction on an optionConstructor parameters in com.github.rvesse.airline.help.markdown with type arguments of type HelpHintModifierConstructorDescriptionMarkdownGlobalUsageGenerator
(int columnSize, Comparator<? super HelpHint> hintComparator, Comparator<? super OptionMetadata> optionComparator, Comparator<? super CommandMetadata> commandComparator, Comparator<? super CommandGroupMetadata> commandGroupComparator, boolean includeHidden, AbstractPrintedCommandUsageGenerator commandUsageGenerator) -
Uses of HelpHint in com.github.rvesse.airline.help.sections
Subinterfaces of HelpHint in com.github.rvesse.airline.help.sectionsModifier and TypeInterfaceDescriptioninterface
Interface for classes that represents additional help sections -
Uses of HelpHint in com.github.rvesse.airline.help.sections.common
Classes in com.github.rvesse.airline.help.sections.common that implement HelpHintModifier and TypeClassDescriptionclass
class
class
class
class
class
class
-
Uses of HelpHint in com.github.rvesse.airline.restrictions.common
Classes in com.github.rvesse.airline.restrictions.common that implement HelpHintModifier and TypeClassDescriptionclass
class
class
class
class
A restriction that requires raw values to end with one of a set of suffixesclass
A restriction that requires string values meet length constraintsclass
A restriction that enforces that values CANNOT look like optionsclass
class
class
class
class
Implements restriction on options and arguments that expect to receive a path to a file and/or directoryclass
A restriction which requires the raw values to match a given regular expressionclass
class
Restriction that enforces that values must be either positive/negative with zero optionally includedclass
A restriction that requires the value (after type conversion) to be within a given rangeclass
A restriction that requires raw values to start with one of a set of prefixesFields in com.github.rvesse.airline.restrictions.common declared as HelpHint -
Uses of HelpHint in com.github.rvesse.airline.restrictions.options
Classes in com.github.rvesse.airline.restrictions.options that implement HelpHintModifier and TypeClassDescriptionclass
class
class
A restriction that requires an option/argument be set UNLESS a suitable environment variable is specified.class