Uses of Interface
com.github.rvesse.airline.help.sections.HelpHint
-
-
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 Modifier and Type Class Description class
RelatedCommandsSection
-
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 Modifier and Type Class Description class
MultipleOfRestriction
-
Uses of HelpHint in com.github.rvesse.airline.help
Fields in com.github.rvesse.airline.help with type parameters of type HelpHint Modifier and Type Field Description static java.util.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 HelpHint Modifier and Type Method Description static 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 HelpHint Constructor Description CliCommandGroupUsageGenerator(int columns, boolean hideGlobalOptions, java.util.Comparator<? super HelpHint> hintComparator, java.util.Comparator<? super OptionMetadata> optionComparator, java.util.Comparator<? super CommandMetadata> commandComparator, boolean includeHidden)
CliGlobalUsageGenerator(int columnSize, java.util.Comparator<? super HelpHint> hintComparator, java.util.Comparator<? super OptionMetadata> optionComparator, java.util.Comparator<? super CommandMetadata> commandComparator, java.util.Comparator<? super CommandGroupMetadata> commandGroupComparator, boolean includeHidden)
CliGlobalUsageSummaryGenerator(int columnSize, java.util.Comparator<? super HelpHint> hintComparator, java.util.Comparator<? super OptionMetadata> optionComparator, java.util.Comparator<? super CommandMetadata> commandComparator, java.util.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 HelpHint Modifier and Type Field Description private java.util.Comparator<? super HelpHint>
AbstractUsageGenerator. hintComparator
Methods in com.github.rvesse.airline.help.common that return types with arguments of type HelpHint Modifier and Type Method Description protected java.util.List<HelpHint>
AbstractUsageGenerator. sortArgumentsRestrictions(java.util.List<ArgumentsRestriction> restrictions)
protected java.util.List<HelpHint>
AbstractUsageGenerator. sortOptionRestrictions(java.util.List<OptionRestriction> restrictions)
Constructor parameters in com.github.rvesse.airline.help.common with type arguments of type HelpHint Constructor Description AbstractCommandGroupUsageGenerator(java.util.Comparator<? super HelpHint> hintComparator, java.util.Comparator<? super OptionMetadata> optionComparator, java.util.Comparator<? super CommandMetadata> commandComparator, boolean includeHidden)
AbstractCommandUsageGenerator(java.util.Comparator<? super HelpHint> hintComparator, java.util.Comparator<? super OptionMetadata> optionComparator, java.util.Comparator<? super java.util.Map.Entry<java.lang.Integer,java.lang.String>> exitCodeComparator, boolean includeHidden)
AbstractGlobalUsageGenerator(java.util.Comparator<? super HelpHint> hintComparator, java.util.Comparator<? super OptionMetadata> optionComparator, java.util.Comparator<? super CommandMetadata> commandComparator, java.util.Comparator<? super CommandGroupMetadata> commandGroupComparator, boolean includeHidden)
AbstractPrintedCommandGroupUsageGenerator(int columnSize, java.util.Comparator<? super HelpHint> hintComparator, java.util.Comparator<? super OptionMetadata> optionComparator, java.util.Comparator<? super CommandMetadata> commandComparator, boolean includeHidden)
AbstractPrintedGlobalUsageGenerator(int columns, java.util.Comparator<? super HelpHint> hintComparator, java.util.Comparator<? super OptionMetadata> optionComparator, java.util.Comparator<? super CommandMetadata> commandComparator, java.util.Comparator<? super CommandGroupMetadata> commandGroupComparator, boolean includeHidden)
AbstractUsageGenerator(java.util.Comparator<? super HelpHint> hintComparator, java.util.Comparator<? super OptionMetadata> optionComparator, java.util.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 HelpHint Modifier and Type Method Description protected void
HtmlCommandUsageGenerator. outputHelpHint(java.io.Writer writer, HelpHint hint)
Outputs a help hintprotected void
HtmlCommandUsageGenerator. outputOptionRestriction(java.io.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 HelpHint Modifier and Type Method Description protected 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 HelpHint Modifier and Type Method Description static 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 HelpHint Constructor Description MarkdownGlobalUsageGenerator(int columnSize, java.util.Comparator<? super HelpHint> hintComparator, java.util.Comparator<? super OptionMetadata> optionComparator, java.util.Comparator<? super CommandMetadata> commandComparator, java.util.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.sections Modifier and Type Interface Description interface
HelpSection
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 HelpHint Modifier and Type Class Description class
BasicHint
class
BasicSection
class
DiscussionSection
class
ExamplesSection
class
ExitCodesSection
class
ProseSection
class
VersionSection
-
Uses of HelpHint in com.github.rvesse.airline.restrictions.common
Classes in com.github.rvesse.airline.restrictions.common that implement HelpHint Modifier and Type Class Description class
AbstractAllowedValuesRestriction
class
AllowedEnumValuesRestriction
class
AllowedRawValuesRestriction
class
AllowedValuesRestriction
class
EndsWithRestriction
A restriction that requires raw values to end with one of a set of suffixesclass
LengthRestriction
A restriction that requires string values meet length constraintsclass
NoOptionLikeValuesRestriction
A restriction that enforces that values CANNOT look like optionsclass
NotBlankRestriction
class
NotEmptyRestriction
class
OccurrencesRestriction
class
PartialRestriction
class
PathRestriction
Implements restriction on options and arguments that expect to receive a path to a file and/or directoryclass
PatternRestriction
A restriction which requires the raw values to match a given regular expressionclass
PortRestriction
class
PositiveNegativeRestriction
Restriction that enforces that values must be either positive/negative with zero optionally includedclass
RangeRestriction
A restriction that requires the value (after type conversion) to be within a given rangeclass
StartsWithRestriction
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 Modifier and Type Field Description private HelpHint
PartialRestriction. hint
-
Uses of HelpHint in com.github.rvesse.airline.restrictions.options
Classes in com.github.rvesse.airline.restrictions.options that implement HelpHint Modifier and Type Class Description class
MutuallyExclusiveRestriction
class
RequiredOnlyIfRestriction
class
RequiredUnlessEnvironmentRestriction
A restriction that requires an option/argument be set UNLESS a suitable environment variable is specified.class
RequireFromRestriction
-