A B C D E F G H I J K L M N O P Q R S T U V W X Y
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbbreviatedCommandFinder - Class in com.github.rvesse.airline.utils.predicates.parser
- AbbreviatedCommandFinder(String, Collection<CommandMetadata>) - Constructor for class com.github.rvesse.airline.utils.predicates.parser.AbbreviatedCommandFinder
- AbbreviatedGroupFinder - Class in com.github.rvesse.airline.utils.predicates.parser
- AbbreviatedGroupFinder(String, Collection<CommandGroupMetadata>) - Constructor for class com.github.rvesse.airline.utils.predicates.parser.AbbreviatedGroupFinder
- AbbreviatedNumericTypeConverter - Class in com.github.rvesse.airline.types.numerics.abbreviated
- AbbreviatedNumericTypeConverter() - Constructor for class com.github.rvesse.airline.types.numerics.abbreviated.AbbreviatedNumericTypeConverter
- AbbreviatedOptionFinder - Class in com.github.rvesse.airline.utils.predicates.parser
- AbbreviatedOptionFinder(String, Collection<OptionMetadata>) - Constructor for class com.github.rvesse.airline.utils.predicates.parser.AbbreviatedOptionFinder
- AbbreviationCli - Class in com.github.rvesse.airline.examples.cli
-
An example of creating a CLI with abbreviation enabled
- AbbreviationCli() - Constructor for class com.github.rvesse.airline.examples.cli.AbbreviationCli
- AbstractAbbreviationFinder<T> - Class in com.github.rvesse.airline.utils.predicates
- AbstractAbbreviationFinder(String, Collection<T>) - Constructor for class com.github.rvesse.airline.utils.predicates.AbstractAbbreviationFinder
- AbstractAllowedValuesRestriction - Class in com.github.rvesse.airline.restrictions.common
- AbstractAllowedValuesRestriction(boolean) - Constructor for class com.github.rvesse.airline.restrictions.common.AbstractAllowedValuesRestriction
- AbstractBuilder<T> - Class in com.github.rvesse.airline.builder
-
Abstract base class for builders
- AbstractBuilder() - Constructor for class com.github.rvesse.airline.builder.AbstractBuilder
- AbstractChildBuilder<T,TParent,TBuilder extends AbstractBuilder<TParent>> - Class in com.github.rvesse.airline.builder
-
A builder that is a child of another builder
- AbstractChildBuilder(TBuilder) - Constructor for class com.github.rvesse.airline.builder.AbstractChildBuilder
-
Creates a child builder
- AbstractCollectingHandler - Class in com.github.rvesse.airline.parser.errors.handlers
- AbstractCollectingHandler() - Constructor for class com.github.rvesse.airline.parser.errors.handlers.AbstractCollectingHandler
- AbstractCommandGroupUsageGenerator<T> - Class in com.github.rvesse.airline.help.common
-
Abstract command group usage generator
- AbstractCommandGroupUsageGenerator() - Constructor for class com.github.rvesse.airline.help.common.AbstractCommandGroupUsageGenerator
- AbstractCommandGroupUsageGenerator(Comparator<? super HelpHint>, Comparator<? super OptionMetadata>, Comparator<? super CommandMetadata>, boolean) - Constructor for class com.github.rvesse.airline.help.common.AbstractCommandGroupUsageGenerator
- AbstractCommandParser<T> - Class in com.github.rvesse.airline.parser
-
Abstract implementation of a parser for commands that can cope with both CLI and Single Command parsing
- AbstractCommandParser() - Constructor for class com.github.rvesse.airline.parser.AbstractCommandParser
- AbstractCommandUsageGenerator - Class in com.github.rvesse.airline.help.common
-
Abstract command usage generator
- AbstractCommandUsageGenerator() - Constructor for class com.github.rvesse.airline.help.common.AbstractCommandUsageGenerator
- AbstractCommandUsageGenerator(boolean) - Constructor for class com.github.rvesse.airline.help.common.AbstractCommandUsageGenerator
- AbstractCommandUsageGenerator(Comparator<? super HelpHint>, Comparator<? super OptionMetadata>, Comparator<? super Map.Entry<Integer, String>>, boolean) - Constructor for class com.github.rvesse.airline.help.common.AbstractCommandUsageGenerator
- AbstractCommandUsageGenerator(Comparator<? super OptionMetadata>) - Constructor for class com.github.rvesse.airline.help.common.AbstractCommandUsageGenerator
- AbstractCommandUsageGenerator(Comparator<? super OptionMetadata>, boolean) - Constructor for class com.github.rvesse.airline.help.common.AbstractCommandUsageGenerator
- AbstractCommonRestriction - Class in com.github.rvesse.airline.restrictions
- AbstractCommonRestriction() - Constructor for class com.github.rvesse.airline.restrictions.AbstractCommonRestriction
- AbstractComparableComparator<T extends java.lang.Comparable<T>> - Class in com.github.rvesse.airline.utils.comparators
- AbstractComparableComparator(Class<T>) - Constructor for class com.github.rvesse.airline.utils.comparators.AbstractComparableComparator
- AbstractGlobalUsageGenerator<T> - Class in com.github.rvesse.airline.help.common
-
Abstract global usage generator
- AbstractGlobalUsageGenerator() - Constructor for class com.github.rvesse.airline.help.common.AbstractGlobalUsageGenerator
- AbstractGlobalUsageGenerator(boolean) - Constructor for class com.github.rvesse.airline.help.common.AbstractGlobalUsageGenerator
- AbstractGlobalUsageGenerator(Comparator<? super HelpHint>, Comparator<? super OptionMetadata>, Comparator<? super CommandMetadata>, Comparator<? super CommandGroupMetadata>, boolean) - Constructor for class com.github.rvesse.airline.help.common.AbstractGlobalUsageGenerator
- AbstractLocaleAndCaseStringRestriction - Class in com.github.rvesse.airline.restrictions.common
-
An abstract string restriction that needs a locale and case sensitivity flag
- AbstractLocaleAndCaseStringRestriction(boolean, Locale) - Constructor for class com.github.rvesse.airline.restrictions.common.AbstractLocaleAndCaseStringRestriction
-
Creates the restriction
- AbstractLocaleSensitiveStringFinder - Class in com.github.rvesse.airline.utils.predicates
- AbstractLocaleSensitiveStringFinder(Locale) - Constructor for class com.github.rvesse.airline.utils.predicates.AbstractLocaleSensitiveStringFinder
- AbstractNameValueOptionParser<T> - Class in com.github.rvesse.airline.parser.options
-
Abstract option parser for options that are specified in
--name=value
style while the separator character (in this example=
) can be configured as desired. - AbstractNameValueOptionParser() - Constructor for class com.github.rvesse.airline.parser.options.AbstractNameValueOptionParser
-
Creates a new parser with the default separator (
=
) - AbstractNameValueOptionParser(char) - Constructor for class com.github.rvesse.airline.parser.options.AbstractNameValueOptionParser
-
Creates a new parser with the desired separator character
- AbstractObjectComparator<T> - Class in com.github.rvesse.airline.utils.comparators
- AbstractObjectComparator(Class<T>) - Constructor for class com.github.rvesse.airline.utils.comparators.AbstractObjectComparator
- AbstractOptionParser<T> - Class in com.github.rvesse.airline.parser.options
-
Abstract option parser that provides some useful helper methods to derived classes
- AbstractOptionParser() - Constructor for class com.github.rvesse.airline.parser.options.AbstractOptionParser
- AbstractOptionRestrictionBasedFinder - Class in com.github.rvesse.airline.utils.predicates.restrictions
- AbstractOptionRestrictionBasedFinder() - Constructor for class com.github.rvesse.airline.utils.predicates.restrictions.AbstractOptionRestrictionBasedFinder
- AbstractParsedOptionRestrictionBasedFinder - Class in com.github.rvesse.airline.utils.predicates.restrictions
- AbstractParsedOptionRestrictionBasedFinder() - Constructor for class com.github.rvesse.airline.utils.predicates.restrictions.AbstractParsedOptionRestrictionBasedFinder
- AbstractParser<T> - Class in com.github.rvesse.airline.parser
-
Abstract base class for parsers providing some utility methods
- AbstractParser() - Constructor for class com.github.rvesse.airline.parser.AbstractParser
- AbstractPlaceholderLocator - Class in com.github.rvesse.airline.parser.resources
-
A resource locator that supports placeholders of the form
${name}
which when found calls theAbstractPlaceholderLocator.resolvePlaceholder(String)
method to try and resolve the encountered placeholders. - AbstractPlaceholderLocator() - Constructor for class com.github.rvesse.airline.parser.resources.AbstractPlaceholderLocator
- AbstractPrintedCommandGroupUsageGenerator<T> - Class in com.github.rvesse.airline.help.common
-
Abstract command group usage generator for generators that use a
UsagePrinter
to generate the documentation - AbstractPrintedCommandGroupUsageGenerator(int, Comparator<? super HelpHint>, Comparator<? super OptionMetadata>, Comparator<? super CommandMetadata>, boolean) - Constructor for class com.github.rvesse.airline.help.common.AbstractPrintedCommandGroupUsageGenerator
- AbstractPrintedCommandUsageGenerator - Class in com.github.rvesse.airline.help.common
-
Abstract command usage generator for generators that use a
UsagePrinter
to generate the documentation - AbstractPrintedCommandUsageGenerator(int, Comparator<? super OptionMetadata>, boolean) - Constructor for class com.github.rvesse.airline.help.common.AbstractPrintedCommandUsageGenerator
- AbstractPrintedGlobalUsageGenerator<T> - Class in com.github.rvesse.airline.help.common
-
Abstract global usage generator for generators that use a
UsagePrinter
to generate the documentation - AbstractPrintedGlobalUsageGenerator(int, Comparator<? super HelpHint>, Comparator<? super OptionMetadata>, Comparator<? super CommandMetadata>, Comparator<? super CommandGroupMetadata>, boolean) - Constructor for class com.github.rvesse.airline.help.common.AbstractPrintedGlobalUsageGenerator
- AbstractRequiredUnlessRestriction - Class in com.github.rvesse.airline.restrictions.options
-
A restriction that options/arguments are required unless some other criteria is met
- AbstractRequiredUnlessRestriction() - Constructor for class com.github.rvesse.airline.restrictions.options.AbstractRequiredUnlessRestriction
- AbstractStringRestriction - Class in com.github.rvesse.airline.restrictions.common
-
Abstract restrictions on string values for options and arguments
- AbstractStringRestriction() - Constructor for class com.github.rvesse.airline.restrictions.common.AbstractStringRestriction
- AbstractUsageGenerator - Class in com.github.rvesse.airline.help.common
- AbstractUsageGenerator() - Constructor for class com.github.rvesse.airline.help.common.AbstractUsageGenerator
- AbstractUsageGenerator(Comparator<? super HelpHint>, Comparator<? super OptionMetadata>, Comparator<? super CommandMetadata>, boolean) - Constructor for class com.github.rvesse.airline.help.common.AbstractUsageGenerator
- acceptablePorts - Variable in class com.github.rvesse.airline.restrictions.common.PortRestriction
- acceptablePorts() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.Port
-
The acceptable port types, defaults to
PortType#OS_ALLOCATED
,PortType#USER
andPortType#DYNAMIC
- Accessor - Class in com.github.rvesse.airline
- Accessor(Iterable<Field>) - Constructor for class com.github.rvesse.airline.Accessor
- Accessor(Field...) - Constructor for class com.github.rvesse.airline.Accessor
- Accessor(Iterator<Field>) - Constructor for class com.github.rvesse.airline.Accessor
- Accessor(List<Field>) - Constructor for class com.github.rvesse.airline.Accessor
- accessors - Variable in class com.github.rvesse.airline.model.ArgumentsMetadata
- accessors - Variable in class com.github.rvesse.airline.model.OptionMetadata
- addAdditionalColumn(String[], int, String) - Method in class com.github.rvesse.airline.help.sections.common.VersionSection.VersionInfo
- addArgumentsRestriction(Class<? extends Annotation>, ArgumentsRestrictionFactory) - Static method in class com.github.rvesse.airline.restrictions.factories.RestrictionRegistry
- addBuild(String[], int) - Method in class com.github.rvesse.airline.help.sections.common.VersionSection.VersionInfo
- addBuildDate(String[], int) - Method in class com.github.rvesse.airline.help.sections.common.VersionSection.VersionInfo
- addCommand(CommandMetadata) - Method in class com.github.rvesse.airline.model.CommandGroupMetadata
-
Adds a command to the group
- addComponent(String[], int) - Method in class com.github.rvesse.airline.help.sections.common.VersionSection.VersionInfo
- addFactory(Class<? extends Annotation>, HelpSectionFactory) - Static method in class com.github.rvesse.airline.help.sections.factories.HelpSectionRegistry
-
Registers a help section factory for a given annotation class
- addGlobalRestriction(Class<? extends Annotation>, GlobalRestrictionFactory) - Static method in class com.github.rvesse.airline.restrictions.factories.RestrictionRegistry
- additional - Variable in class com.github.rvesse.airline.help.sections.common.VersionSection.VersionInfo
- additionalProperties() - Method in annotation type com.github.rvesse.airline.annotations.help.Version
-
Any additional properties from which information should be obtained
- additionalTitles() - Method in annotation type com.github.rvesse.airline.annotations.help.Version
-
The titles for the additional properties specified by
Version.additionalProperties()
used to present this information in generated help output - addOptionRestriction(Class<? extends Annotation>, OptionRestrictionFactory) - Static method in class com.github.rvesse.airline.restrictions.factories.RestrictionRegistry
- address - Variable in class com.github.rvesse.airline.examples.sendit.CheckAddress
- address - Variable in class com.github.rvesse.airline.examples.sendit.Send
- addressLines - Variable in class com.github.rvesse.airline.examples.sendit.PostalAddress
- addSubGroup(CommandGroupMetadata) - Method in class com.github.rvesse.airline.model.CommandGroupMetadata
-
Adds a sub-group to the group
- addValues(Object, Iterable<?>) - Method in class com.github.rvesse.airline.Accessor
- addVersion(String[], int) - Method in class com.github.rvesse.airline.help.sections.common.VersionSection.VersionInfo
- AIRLINE_MODULE - Static variable in class com.github.rvesse.airline.model.MetadataLoader
-
Constant for the
AirlineModule
annotation class - AirlineModule - Annotation Type in com.github.rvesse.airline.annotations
-
Used to mark a field of a command class as representing a module of command functionality.
- AirlineUtils - Class in com.github.rvesse.airline.utils
- AirlineUtils() - Constructor for class com.github.rvesse.airline.utils.AirlineUtils
- Alias - Annotation Type in com.github.rvesse.airline.annotations
-
Specifies a command alias
- AliasArgumentsParser - Class in com.github.rvesse.airline.parser.aliases
- AliasArgumentsParser(String) - Constructor for class com.github.rvesse.airline.parser.aliases.AliasArgumentsParser
- AliasBuilder<C> - Class in com.github.rvesse.airline.builder
-
Builds a command alias
- AliasBuilder(ParserBuilder<C>) - Constructor for class com.github.rvesse.airline.builder.AliasBuilder
-
Creates a new alias builder
- AliasBuilder(ParserBuilder<C>, String) - Constructor for class com.github.rvesse.airline.builder.AliasBuilder
-
Creates a new alias builder
- AliasedCli - Class in com.github.rvesse.airline.examples.cli.aliases
-
An example of creating a CLI that takes advantage of the aliases feature.
- AliasedCli() - Constructor for class com.github.rvesse.airline.examples.cli.aliases.AliasedCli
- aliases - Variable in class com.github.rvesse.airline.builder.ParserBuilder
- aliases - Variable in class com.github.rvesse.airline.model.ParserMetadata
- aliases() - Method in annotation type com.github.rvesse.airline.annotations.Parser
-
Defines command aliases
- aliasesForceBuiltInPrefix() - Method in annotation type com.github.rvesse.airline.annotations.Parser
-
Sets a character used in alias definitions to indicate that the built-in should be called regardless of the setting of
Parser.aliasesOverrideBuiltIns()
- aliasesMayChain - Variable in class com.github.rvesse.airline.builder.ParserBuilder
- aliasesMayChain - Variable in class com.github.rvesse.airline.model.ParserMetadata
- aliasesMayChain() - Method in annotation type com.github.rvesse.airline.annotations.Parser
-
Controls whether command alises may be chained i.e.
- aliasesMayChain() - Method in class com.github.rvesse.airline.model.ParserMetadata
-
Gets whether aliases may chain i.e.
- aliasesOverrideBuiltIns - Variable in class com.github.rvesse.airline.builder.ParserBuilder
- aliasesOverrideBuiltIns - Variable in class com.github.rvesse.airline.model.ParserMetadata
- aliasesOverrideBuiltIns() - Method in annotation type com.github.rvesse.airline.annotations.Parser
-
Controls whether aliases are allowed to override built-in commands i.e.
- aliasesOverrideBuiltIns() - Method in class com.github.rvesse.airline.model.ParserMetadata
-
Gets whether aliases can override built-in commands
- AliasFinder - Class in com.github.rvesse.airline.utils.predicates.parser
- AliasFinder(String) - Constructor for class com.github.rvesse.airline.utils.predicates.parser.AliasFinder
- AliasMetadata - Class in com.github.rvesse.airline.model
-
Metadata about command aliases
- AliasMetadata(String, List<String>) - Constructor for class com.github.rvesse.airline.model.AliasMetadata
-
Creates a new alias metadata
- AliasResolver<T> - Class in com.github.rvesse.airline.parser.aliases
-
Resolves aliases
- AliasResolver() - Constructor for class com.github.rvesse.airline.parser.aliases.AliasResolver
- allowAbbreviatedCommands - Variable in class com.github.rvesse.airline.builder.ParserBuilder
- allowAbbreviatedCommands - Variable in class com.github.rvesse.airline.model.ParserMetadata
- allowAbbreviatedOptions - Variable in class com.github.rvesse.airline.builder.ParserBuilder
- allowAbbreviatedOptions - Variable in class com.github.rvesse.airline.model.ParserMetadata
- allowCommandAbbreviation() - Method in annotation type com.github.rvesse.airline.annotations.Parser
-
Controls whether command names may be abbreviated provided such abbreviations are unambiguous (default false)
- AllowedEnumValues - Annotation Type in com.github.rvesse.airline.annotations.restrictions
-
Annotation that marks that the option/arguments are restricted to a given set of raw string values as defined by a given enum type
- AllowedEnumValuesRestriction - Class in com.github.rvesse.airline.restrictions.common
- AllowedEnumValuesRestriction(Class<? extends Enum<?>>) - Constructor for class com.github.rvesse.airline.restrictions.common.AllowedEnumValuesRestriction
- AllowedRawValues - Annotation Type in com.github.rvesse.airline.annotations.restrictions
-
Annotation that marks that the option/arguments are restricted to a given set of raw string values
- AllowedRawValuesRestriction - Class in com.github.rvesse.airline.restrictions.common
- AllowedRawValuesRestriction(boolean, Locale, String...) - Constructor for class com.github.rvesse.airline.restrictions.common.AllowedRawValuesRestriction
- allowedValues - Variable in exception com.github.rvesse.airline.parser.errors.ParseArgumentsIllegalValueException
- allowedValues - Variable in exception com.github.rvesse.airline.parser.errors.ParseOptionIllegalValueException
- allowedValues - Variable in class com.github.rvesse.airline.restrictions.common.AllowedValuesRestriction
- allowedValues() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.AllowedRawValues
-
If provided restricts the values for the option to the given set of values
- allowedValues() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.AllowedValues
-
If provided restricts the values for the option to the given set of values
- AllowedValues - Annotation Type in com.github.rvesse.airline.annotations.restrictions
-
Annotation that marks that the option/arguments are restricted to a given set of values
- AllowedValuesOptionFinder - Class in com.github.rvesse.airline.utils.predicates.restrictions
- AllowedValuesOptionFinder() - Constructor for class com.github.rvesse.airline.utils.predicates.restrictions.AllowedValuesOptionFinder
- AllowedValuesRestriction - Class in com.github.rvesse.airline.restrictions.common
- AllowedValuesRestriction(String...) - Constructor for class com.github.rvesse.airline.restrictions.common.AllowedValuesRestriction
- AllowedValuesRestrictionFactory - Class in com.github.rvesse.airline.restrictions.factories
- AllowedValuesRestrictionFactory() - Constructor for class com.github.rvesse.airline.restrictions.factories.AllowedValuesRestrictionFactory
- allowNumericOptionSelection - Variable in class com.github.rvesse.airline.prompts.Prompt
- allowOptionAbbreviation() - Method in annotation type com.github.rvesse.airline.annotations.Parser
-
Controls whether options names may be abbreviated provided such abbreviations are unambiguous (default false)
- allowsAbbreviatedCommands() - Method in class com.github.rvesse.airline.model.ParserMetadata
-
Gets whether command/group name abbreviation is allowed
- allowsAbbreviatedOptions() - Method in class com.github.rvesse.airline.model.ParserMetadata
-
Gets whether option name abbreviation is allowed
- allowsFlagNegation() - Method in class com.github.rvesse.airline.model.ParserMetadata
-
Gets whether this configuration allows flag negation
- allowsNumericOptionSelection - Variable in class com.github.rvesse.airline.prompts.builders.PromptBuilder
- allowsNumericOptionSelection() - Method in class com.github.rvesse.airline.prompts.Prompt
-
Gets whether options can be selected numerically when using
Prompt.promptForOption(boolean)
- ambiguousResponse(String) - Static method in class com.github.rvesse.airline.prompts.matchers.MatcherUtils
-
Provides an error indicating that the response was ambiguous i.e.
- Ansi256ColorizedOutputStream - Class in com.github.rvesse.airline.io.output
-
A colorized output stream supporting the ANSI 256 colour palette
- Ansi256ColorizedOutputStream(OutputStream) - Constructor for class com.github.rvesse.airline.io.output.Ansi256ColorizedOutputStream
- Ansi256ColorizedWriter - Class in com.github.rvesse.airline.io.writers
-
A colorized writer supporting the ANSI 256 colour palette
- Ansi256ColorizedWriter(Writer) - Constructor for class com.github.rvesse.airline.io.writers.Ansi256ColorizedWriter
- AnsiBackgroundColorSource<T extends AnsiColorProvider> - Class in com.github.rvesse.airline.io.colors.sources
-
An ANSI colour source for background colours
- AnsiBackgroundColorSource() - Constructor for class com.github.rvesse.airline.io.colors.sources.AnsiBackgroundColorSource
- AnsiBasicColorizedOutputStream - Class in com.github.rvesse.airline.io.output
-
A colorized output stream supporting the basic ANSI colours
- AnsiBasicColorizedOutputStream(OutputStream) - Constructor for class com.github.rvesse.airline.io.output.AnsiBasicColorizedOutputStream
- AnsiBasicColorizedWriter - Class in com.github.rvesse.airline.io.writers
-
A colorized writer supporting the basic ANSI colors
- AnsiBasicColorizedWriter(Writer) - Constructor for class com.github.rvesse.airline.io.writers.AnsiBasicColorizedWriter
- AnsiColorProvider - Interface in com.github.rvesse.airline.io.colors
-
Interface that may be implemented by colour providers
- AnsiColorSource<T extends AnsiColorProvider> - Class in com.github.rvesse.airline.io.colors.sources
- AnsiColorSource() - Constructor for class com.github.rvesse.airline.io.colors.sources.AnsiColorSource
- AnsiColorSource(boolean) - Constructor for class com.github.rvesse.airline.io.colors.sources.AnsiColorSource
- AnsiControlCodes - Class in com.github.rvesse.airline.io
-
Constants
- AnsiControlCodes() - Constructor for class com.github.rvesse.airline.io.AnsiControlCodes
-
Private constructor to prevent instantiation
- AnsiDecorationProvider - Interface in com.github.rvesse.airline.io.decorations
-
Interface for classes that provide ANSI decorations
- AnsiDecorationSource<T extends AnsiDecorationProvider> - Class in com.github.rvesse.airline.io.decorations.sources
- AnsiDecorationSource() - Constructor for class com.github.rvesse.airline.io.decorations.sources.AnsiDecorationSource
- AnsiForegroundColorSource<T extends AnsiColorProvider> - Class in com.github.rvesse.airline.io.colors.sources
-
An ANSI colour source for background colours
- AnsiForegroundColorSource() - Constructor for class com.github.rvesse.airline.io.colors.sources.AnsiForegroundColorSource
- AnsiOutputStream - Class in com.github.rvesse.airline.io.output
-
An output stream that supports customized output via ANSI control codes
- AnsiOutputStream(OutputStream) - Constructor for class com.github.rvesse.airline.io.output.AnsiOutputStream
- AnsiTrueColorizedOutputStream - Class in com.github.rvesse.airline.io.output
-
A colorized output stream supporting ANSI true colour (24 bit i.e.
- AnsiTrueColorizedOutputStream(OutputStream) - Constructor for class com.github.rvesse.airline.io.output.AnsiTrueColorizedOutputStream
- AnsiTrueColorizedWriter - Class in com.github.rvesse.airline.io.writers
-
A colorized writer supporting ANSI true colour (24 bit i.e.
- AnsiTrueColorizedWriter(Writer) - Constructor for class com.github.rvesse.airline.io.writers.AnsiTrueColorizedWriter
- AnsiWriter - Class in com.github.rvesse.airline.io.writers
-
A writer that supports customizing the output with ANSI control codes
- AnsiWriter(Writer) - Constructor for class com.github.rvesse.airline.io.writers.AnsiWriter
- ANY - com.github.rvesse.airline.annotations.restrictions.PathKind
-
Any path
- ANY - com.github.rvesse.airline.annotations.restrictions.PortType
-
Any port
- append(String) - Method in class com.github.rvesse.airline.io.printers.UsagePrinter
- append(String, boolean) - Method in class com.github.rvesse.airline.io.printers.UsagePrinter
- appendLine(String) - Method in class com.github.rvesse.airline.io.printers.TroffPrinter
- appendLines(Iterable<String>) - Method in class com.github.rvesse.airline.io.printers.UsagePrinter
- appendLines(Iterable<String>, boolean) - Method in class com.github.rvesse.airline.io.printers.UsagePrinter
- appendOnOneLine(String) - Method in class com.github.rvesse.airline.io.printers.UsagePrinter
- appendTable(Iterable<? extends Iterable<String>>, int) - Method in class com.github.rvesse.airline.io.printers.UsagePrinter
- appendWords(Iterable<String>) - Method in class com.github.rvesse.airline.io.printers.UsagePrinter
- appendWords(Iterable<String>, boolean) - Method in class com.github.rvesse.airline.io.printers.UsagePrinter
- appendWords(String[]) - Method in class com.github.rvesse.airline.io.printers.UsagePrinter
- appendWords(String[], boolean) - Method in class com.github.rvesse.airline.io.printers.UsagePrinter
- appliesTo() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.Partial
-
Specifies the indices (zero-based) to which the restriction should actually apply
- apply() - Method in class com.github.rvesse.airline.io.ControlTracker
-
Applies the control, if the current state of the control has not been previously applied to the stream then it will be applied now
- applyAliases(PeekingIterator<String>, ParseState<T>) - Method in class com.github.rvesse.airline.parser.AbstractCommandParser
- applyAll() - Method in class com.github.rvesse.airline.io.output.AnsiOutputStream
-
Method which applies any necessary controls to the stream
- applyAll() - Method in class com.github.rvesse.airline.io.writers.AnsiWriter
- applyInternal(T) - Method in class com.github.rvesse.airline.io.ControlTracker
-
Method that derived classes must implement to add the actual logic for applying the control to the stream
- applyInternal(T) - Method in class com.github.rvesse.airline.io.output.OutputStreamControlTracker
- applyInternal(T) - Method in class com.github.rvesse.airline.io.writers.WriterControlTracker
- args - Variable in class com.github.rvesse.airline.examples.io.ColorDemo
- args - Variable in class com.github.rvesse.airline.examples.io.Decorations
- args - Variable in class com.github.rvesse.airline.examples.modules.ModuleReuse
- args - Variable in class com.github.rvesse.airline.examples.simple.RequiredArguments
- args - Variable in class com.github.rvesse.airline.examples.simple.Simple
-
The
Arguments
annotation allows commands to take in additional arbitrary arguments - args - Variable in class com.github.rvesse.airline.examples.userguide.GettingStarted
- ARGS - com.github.rvesse.airline.Context
- argsSeparator - Variable in class com.github.rvesse.airline.builder.ParserBuilder
- argsSeparator - Variable in class com.github.rvesse.airline.model.ParserMetadata
- ARGUMENT_RESTRICTION_FACTORIES - Static variable in class com.github.rvesse.airline.restrictions.factories.RestrictionRegistry
- arguments - Variable in class com.github.rvesse.airline.builder.AliasBuilder
- arguments - Variable in class com.github.rvesse.airline.examples.userguide.help.sections.Discussed
- arguments - Variable in class com.github.rvesse.airline.examples.userguide.help.sections.ExternalHelp
- arguments - Variable in class com.github.rvesse.airline.help.suggester.SuggestCommand
- arguments - Variable in class com.github.rvesse.airline.model.AliasMetadata
- arguments - Variable in class com.github.rvesse.airline.model.CommandMetadata
- arguments - Variable in class com.github.rvesse.airline.model.MetadataLoader.InjectionMetadata
- arguments() - Method in annotation type com.github.rvesse.airline.annotations.Alias
-
Arguments for the alias i.e.
- Arguments - Annotation Type in com.github.rvesse.airline.annotations
- ArgumentsMetadata - Class in com.github.rvesse.airline.model
- ArgumentsMetadata(Iterable<ArgumentsMetadata>) - Constructor for class com.github.rvesse.airline.model.ArgumentsMetadata
- ArgumentsMetadata(Iterable<String>, String, Iterable<ArgumentsRestriction>, TypeConverterProvider, Iterable<Field>) - Constructor for class com.github.rvesse.airline.model.ArgumentsMetadata
- argumentsRestriction - Variable in class com.github.rvesse.airline.restrictions.common.PartialRestriction
- ArgumentsRestriction - Interface in com.github.rvesse.airline.restrictions
-
Represents restrictions on arguments
- ArgumentsRestrictionFactory - Interface in com.github.rvesse.airline.restrictions.factories
-
Interface for arguments restriction factories
- argumentsSeparator() - Method in annotation type com.github.rvesse.airline.annotations.Parser
-
Controls the separator that is used to distinguish options from arguments were arguments may be confused as options
- argumentTitles - Variable in exception com.github.rvesse.airline.parser.errors.ParseArgumentsMissingException
- arity - Variable in class com.github.rvesse.airline.model.OptionMetadata
- arity() - Method in annotation type com.github.rvesse.airline.annotations.Option
-
How many parameter values this option will consume.
- AS_DIRECTORIES - com.github.rvesse.airline.help.cli.bash.CompletionBehaviour
-
Use the completions from the option meta-data (if any) but treat them as if they were directory names for additional completion
- AS_FILENAMES - com.github.rvesse.airline.help.cli.bash.CompletionBehaviour
-
Use the completions from the option meta-data (if any) but treat them as if they were filenames for additional completion
- asArg(String) - Method in class com.github.rvesse.airline.io.printers.TroffPrinter
- asObjects(Set<String>) - Static method in class com.github.rvesse.airline.restrictions.common.AbstractAllowedValuesRestriction
B
- b - Variable in class com.github.rvesse.airline.io.colors.TrueColor
- background - Variable in class com.github.rvesse.airline.examples.io.ColorDemo
- BACKGROUND - Static variable in class com.github.rvesse.airline.io.AnsiControlCodes
-
Control Code for setting the background colour
- BACKGROUND_BRIGHT - Static variable in class com.github.rvesse.airline.io.AnsiControlCodes
-
Control Code for setting the high intensity variant of the background colour
- BACKGROUND_EXTENDED - Static variable in class com.github.rvesse.airline.io.AnsiControlCodes
-
Control Code for setting the background colour to an extended colour
- backgroundControl - Variable in class com.github.rvesse.airline.io.output.ColorizedOutputStream
- backgroundControl - Variable in class com.github.rvesse.airline.io.writers.ColorizedWriter
- BadGrandchild - Class in com.github.rvesse.airline.examples.inheritance
-
When inheriting from existing classes the default behaviour is to prevent overriding of options as Airline assumes the conflicting definitions are an error on the part of the developer.
- BadGrandchild() - Constructor for class com.github.rvesse.airline.examples.inheritance.BadGrandchild
- BaseCommand - Class in com.github.rvesse.airline.examples.inheritance
- BaseCommand() - Constructor for class com.github.rvesse.airline.examples.inheritance.BaseCommand
- baseDirectory - Variable in class com.github.rvesse.airline.help.man.ManMultiPageGlobalUsageGenerator
- baseDirectory - Variable in class com.github.rvesse.airline.help.markdown.MarkdownMultiPageGlobalUsageGenerator
- baseHelpSections - Variable in class com.github.rvesse.airline.builder.CliBuilder
- baseHelpSections - Variable in class com.github.rvesse.airline.model.GlobalMetadata
- BashCompletion - Class in com.github.rvesse.airline.examples.cli.commands
- BashCompletion - Annotation Type in com.github.rvesse.airline.annotations.help.bash
-
Annotates a field with Bash completion information
- BashCompletion() - Constructor for class com.github.rvesse.airline.examples.cli.commands.BashCompletion
- BashCompletionGenerator<T> - Class in com.github.rvesse.airline.help.cli.bash
- BashCompletionGenerator() - Constructor for class com.github.rvesse.airline.help.cli.bash.BashCompletionGenerator
- BashCompletionGenerator(boolean, boolean) - Constructor for class com.github.rvesse.airline.help.cli.bash.BashCompletionGenerator
-
Creates a new completion generator
- bashize(String) - Method in class com.github.rvesse.airline.help.cli.bash.BashCompletionGenerator
- BasicCli - Class in com.github.rvesse.airline.examples.userguide
- BasicCli() - Constructor for class com.github.rvesse.airline.examples.userguide.BasicCli
- BasicColor - Enum in com.github.rvesse.airline.io.colors
-
The 8 basic ANSI Colours
- BasicColor(int, String) - Constructor for enum com.github.rvesse.airline.io.colors.BasicColor
- BasicColor(int, String, boolean) - Constructor for enum com.github.rvesse.airline.io.colors.BasicColor
- BasicDecoration - Enum in com.github.rvesse.airline.io.decorations
-
Support for the basic ANSI decorations
- BasicDecoration(int, int, String) - Constructor for enum com.github.rvesse.airline.io.decorations.BasicDecoration
- BasicHint - Class in com.github.rvesse.airline.help.sections.common
- BasicHint(String, HelpFormat, String[]...) - Constructor for class com.github.rvesse.airline.help.sections.common.BasicHint
- BasicSection - Class in com.github.rvesse.airline.help.sections.common
- BasicSection(String, int, String, String, HelpFormat, String[]...) - Constructor for class com.github.rvesse.airline.help.sections.common.BasicSection
- behaviour() - Method in annotation type com.github.rvesse.airline.annotations.help.bash.BashCompletion
-
Sets the desired completion behaviour
- Binary - Class in com.github.rvesse.airline.types.numerics.bases
-
A type converter that supports binary numbers
- Binary() - Constructor for class com.github.rvesse.airline.types.numerics.bases.Binary
- BLACK - com.github.rvesse.airline.io.colors.BasicColor
- BLINK_OFF - Static variable in class com.github.rvesse.airline.io.AnsiControlCodes
- BLINK_RAPID - com.github.rvesse.airline.io.decorations.BasicDecoration
- BLINK_RAPID - Static variable in class com.github.rvesse.airline.io.AnsiControlCodes
- BLINK_SLOW - com.github.rvesse.airline.io.decorations.BasicDecoration
- BLINK_SLOW - Static variable in class com.github.rvesse.airline.io.AnsiControlCodes
- blocks - Variable in class com.github.rvesse.airline.help.sections.common.BasicHint
- blue - Variable in class com.github.rvesse.airline.examples.io.ColorsTrue
- BLUE - com.github.rvesse.airline.io.colors.BasicColor
- bold - Variable in class com.github.rvesse.airline.io.output.ColorizedOutputStream
- bold - Variable in class com.github.rvesse.airline.io.writers.ColorizedWriter
- BOLD - com.github.rvesse.airline.io.decorations.BasicDecoration
- BOLD - Static variable in class com.github.rvesse.airline.io.AnsiControlCodes
- BOLD_OFF - Static variable in class com.github.rvesse.airline.io.AnsiControlCodes
- BRIGHT_BLACK - com.github.rvesse.airline.io.colors.BasicColor
- BRIGHT_BLUE - com.github.rvesse.airline.io.colors.BasicColor
- BRIGHT_CYAN - com.github.rvesse.airline.io.colors.BasicColor
- BRIGHT_GREEN - com.github.rvesse.airline.io.colors.BasicColor
- BRIGHT_MAGENTA - com.github.rvesse.airline.io.colors.BasicColor
- BRIGHT_RED - com.github.rvesse.airline.io.colors.BasicColor
- BRIGHT_WHITE - com.github.rvesse.airline.io.colors.BasicColor
- BRIGHT_YELLOW - com.github.rvesse.airline.io.colors.BasicColor
- build - Variable in class com.github.rvesse.airline.help.sections.common.VersionSection.VersionInfo
- build() - Method in class com.github.rvesse.airline.builder.AbstractBuilder
-
Builds the type
- build() - Method in class com.github.rvesse.airline.builder.AliasBuilder
-
Builds the alias metadata
- build() - Method in class com.github.rvesse.airline.builder.CliBuilder
- build() - Method in class com.github.rvesse.airline.builder.GroupBuilder
- build() - Method in class com.github.rvesse.airline.builder.ParserBuilder
- build() - Method in class com.github.rvesse.airline.builder.UserAliasSourceBuilder
- build() - Method in class com.github.rvesse.airline.prompts.builders.ListFormatBuilder
- build() - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder
- builder(String) - Static method in class com.github.rvesse.airline.Cli
-
Creates a builder for specifying a command line in fluent style
- buildGroupsHierarchy(List<CommandGroupMetadata>, Map<String, CommandGroupMetadata>) - Static method in class com.github.rvesse.airline.model.MetadataLoader
- buildProperty() - Method in annotation type com.github.rvesse.airline.annotations.help.Version
-
Sets the property used to find build information (if any)
- buildSuffixes(long, String...) - Static method in class com.github.rvesse.airline.types.numerics.abbreviated.SequenceAbbreviatedNumericTypeConverter
- buildSuffixes(long, String[][]) - Static method in class com.github.rvesse.airline.types.numerics.abbreviated.MultiSequenceAbbreviatedNumericTypeConverter
- BUILTIN_SUGGESTERS - Static variable in class com.github.rvesse.airline.help.suggester.SuggestCommand
- BULLET - com.github.rvesse.airline.io.printers.TroffPrinter.BulletStyle
- BULLET - com.github.rvesse.airline.io.printers.TroffPrinter.ListType
- BULLET_STYLE_BULLET - Static variable in class com.github.rvesse.airline.io.printers.TroffPrinter
- BULLET_STYLE_DASH - Static variable in class com.github.rvesse.airline.io.printers.TroffPrinter
- BULLET_STYLE_EM_DASH - Static variable in class com.github.rvesse.airline.io.printers.TroffPrinter
- BulletStyle(String) - Constructor for enum com.github.rvesse.airline.io.printers.TroffPrinter.BulletStyle
- BYTE_COMPARATOR - Static variable in class com.github.rvesse.airline.restrictions.factories.RangeRestrictionFactory
- ByteCalculator - Class in com.github.rvesse.airline.examples.userguide.parser
- ByteCalculator() - Constructor for class com.github.rvesse.airline.examples.userguide.parser.ByteCalculator
- ByteComparator - Class in com.github.rvesse.airline.utils.comparators
- ByteComparator() - Constructor for class com.github.rvesse.airline.utils.comparators.ByteComparator
- ByteRange - Annotation Type in com.github.rvesse.airline.annotations.restrictions.ranges
-
Annotation that marks values as being restricted to a given byte range
- byteRestrictor - Variable in class com.github.rvesse.airline.restrictions.common.PositiveNegativeRestriction
- bytes - Variable in class com.github.rvesse.airline.examples.userguide.parser.ByteCalculator
C
- C_LIBRARY_FUNCTIONS - Static variable in class com.github.rvesse.airline.help.man.ManSections
-
C Library Functions
- calculateCost(double) - Method in enum com.github.rvesse.airline.examples.sendit.PostalService
-
Calculate the cost of a parcel
- calculateMaxRows(HelpHint) - Static method in class com.github.rvesse.airline.help.cli.CliUsageHelper
- calculateMaxRows(HelpHint) - Static method in class com.github.rvesse.airline.help.markdown.MarkdownUsageHelper
- calculateVolume() - Method in class com.github.rvesse.airline.examples.sendit.Package
- call() - Method in class com.github.rvesse.airline.help.Help
- call() - Method in class com.github.rvesse.airline.help.suggester.SuggestCommand
- candidates - Variable in class com.github.rvesse.airline.utils.predicates.AbstractAbbreviationFinder
- canGreedySearch(ParseState<T>) - Method in class com.github.rvesse.airline.parser.options.GreedyMaybeListValueOptionParser
- canGreedySearch(ParseState<T>) - Method in class com.github.rvesse.airline.parser.options.MaybeListValueOptionParser
-
Gets whether we can do a greedy search for list value(s)
- CASE_INSENSITIVE - Static variable in class com.github.rvesse.airline.restrictions.common.AbstractAllowedValuesRestriction
- CASE_SENSITIVE - Static variable in class com.github.rvesse.airline.restrictions.common.AbstractAllowedValuesRestriction
- caseInsensitive - Variable in class com.github.rvesse.airline.restrictions.common.AbstractAllowedValuesRestriction
- caseSensitive - Variable in class com.github.rvesse.airline.types.numerics.abbreviated.MapAbbreviatedNumericTypeConverter
- cause - Variable in class com.github.rvesse.airline.types.ConvertResult
- ChannelFactory - Interface in com.github.rvesse.airline
-
Factory for various channels used by airline.
- Channels - Class in com.github.rvesse.airline
-
Channels provides methods for the cli output, error and input channels.
- Channels() - Constructor for class com.github.rvesse.airline.Channels
- charset - Variable in class com.github.rvesse.airline.io.output.OutputStreamControlTracker
- CheckAddress - Class in com.github.rvesse.airline.examples.sendit
- CheckAddress() - Constructor for class com.github.rvesse.airline.examples.sendit.CheckAddress
- checkArguments(String, Class<?>, String) - Static method in class com.github.rvesse.airline.types.DefaultTypeConverter
-
Checks that the arguments are all non-null
- checkColor(int) - Method in class com.github.rvesse.airline.io.colors.Color256
- checkColor(int, String) - Method in class com.github.rvesse.airline.io.colors.TrueColor
- checkForInjectionAnnotation(MetadataLoader.InjectionMetadata, Field, List<Field>, String, ParserMetadata<?>) - Static method in class com.github.rvesse.airline.model.MetadataLoader
- checkForSuppressedCommands(CommandGroupMetadata, String) - Static method in class com.github.rvesse.airline.model.GlobalMetadata
- checkForSuppressedCommands(List<CommandMetadata>, CommandMetadata, String) - Static method in class com.github.rvesse.airline.model.GlobalMetadata
- checkNotBlank(String, String) - Method in class com.github.rvesse.airline.builder.AbstractBuilder
-
Checks a value given for a parameter is not blank i.e.
- checkNotEmpty(String, String) - Method in class com.github.rvesse.airline.builder.AbstractBuilder
-
Checks a value given for a parameter is not null/empty
- checkNotNull(String, String) - Method in class com.github.rvesse.airline.builder.AbstractBuilder
-
Checks a value given for a parameter is not null
- CheckPostcodes - Class in com.github.rvesse.airline.examples.sendit
- CheckPostcodes() - Constructor for class com.github.rvesse.airline.examples.sendit.CheckPostcodes
- child - Variable in class com.github.rvesse.airline.examples.inheritance.Child
- Child - Class in com.github.rvesse.airline.examples.inheritance
- Child() - Constructor for class com.github.rvesse.airline.examples.inheritance.Child
- ClassicGetOptParser<T> - Class in com.github.rvesse.airline.parser.options
-
An options parsing that parses options given in classic get-opt style where multiple options may be concatenated together, potentially including a value for the last option in the concatenation.
- ClassicGetOptParser() - Constructor for class com.github.rvesse.airline.parser.options.ClassicGetOptParser
- CLASSPATH_URI_PREFIX - Static variable in class com.github.rvesse.airline.parser.resources.ClasspathLocator
- ClasspathLocator - Class in com.github.rvesse.airline.parser.resources
-
A resource locator that finds resources on the classpath
- ClasspathLocator() - Constructor for class com.github.rvesse.airline.parser.resources.ClasspathLocator
- clearOptions() - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder
-
Clears all previously specified options
- Cli<C> - Class in com.github.rvesse.airline
-
Class for encapsulating and parsing CLIs
- Cli - Annotation Type in com.github.rvesse.airline.annotations
-
Class annotation used to declaratively specify a CLI
- Cli(GlobalMetadata<C>) - Constructor for class com.github.rvesse.airline.Cli
-
Creates a new CLI
- Cli(Class<?>) - Constructor for class com.github.rvesse.airline.Cli
-
Creates a new CLI from a class annotated with the
Cli
annotation - Cli(Class<?>, ParserMetadata<C>) - Constructor for class com.github.rvesse.airline.Cli
-
Creates a new CLI from a class annotated with the
Cli
annotation - CLI_COMMANDS - com.github.rvesse.airline.help.cli.bash.CompletionBehaviour
-
Commands from the CLI for which we are providing completions
- Cli.NO_DEFAULT - Class in com.github.rvesse.airline.annotations
- cliBuilder - Variable in class com.github.rvesse.airline.builder.ParserBuilder
- CliBuilder<C> - Class in com.github.rvesse.airline.builder
-
Builder for CLIs
- CliBuilder(String) - Constructor for class com.github.rvesse.airline.builder.CliBuilder
- CliCommandGroupUsageGenerator<T> - Class in com.github.rvesse.airline.help.cli
- CliCommandGroupUsageGenerator() - Constructor for class com.github.rvesse.airline.help.cli.CliCommandGroupUsageGenerator
- CliCommandGroupUsageGenerator(boolean) - Constructor for class com.github.rvesse.airline.help.cli.CliCommandGroupUsageGenerator
- CliCommandGroupUsageGenerator(int) - Constructor for class com.github.rvesse.airline.help.cli.CliCommandGroupUsageGenerator
- CliCommandGroupUsageGenerator(int, boolean) - Constructor for class com.github.rvesse.airline.help.cli.CliCommandGroupUsageGenerator
- CliCommandGroupUsageGenerator(int, boolean, Comparator<? super HelpHint>, Comparator<? super OptionMetadata>, Comparator<? super CommandMetadata>, boolean) - Constructor for class com.github.rvesse.airline.help.cli.CliCommandGroupUsageGenerator
- CliCommandUsageGenerator - Class in com.github.rvesse.airline.help.cli
- CliCommandUsageGenerator() - Constructor for class com.github.rvesse.airline.help.cli.CliCommandUsageGenerator
- CliCommandUsageGenerator(boolean) - Constructor for class com.github.rvesse.airline.help.cli.CliCommandUsageGenerator
- CliCommandUsageGenerator(int) - Constructor for class com.github.rvesse.airline.help.cli.CliCommandUsageGenerator
- CliCommandUsageGenerator(int, boolean) - Constructor for class com.github.rvesse.airline.help.cli.CliCommandUsageGenerator
- CliCommandUsageGenerator(int, Comparator<? super OptionMetadata>, boolean) - Constructor for class com.github.rvesse.airline.help.cli.CliCommandUsageGenerator
- CliGlobalUsageGenerator<T> - Class in com.github.rvesse.airline.help.cli
- CliGlobalUsageGenerator() - Constructor for class com.github.rvesse.airline.help.cli.CliGlobalUsageGenerator
- CliGlobalUsageGenerator(boolean) - Constructor for class com.github.rvesse.airline.help.cli.CliGlobalUsageGenerator
- CliGlobalUsageGenerator(int) - Constructor for class com.github.rvesse.airline.help.cli.CliGlobalUsageGenerator
- CliGlobalUsageGenerator(int, boolean) - Constructor for class com.github.rvesse.airline.help.cli.CliGlobalUsageGenerator
- CliGlobalUsageGenerator(int, Comparator<? super HelpHint>, Comparator<? super OptionMetadata>, Comparator<? super CommandMetadata>, Comparator<? super CommandGroupMetadata>, boolean) - Constructor for class com.github.rvesse.airline.help.cli.CliGlobalUsageGenerator
- CliGlobalUsageSummaryGenerator<T> - Class in com.github.rvesse.airline.help.cli
- CliGlobalUsageSummaryGenerator() - Constructor for class com.github.rvesse.airline.help.cli.CliGlobalUsageSummaryGenerator
- CliGlobalUsageSummaryGenerator(boolean) - Constructor for class com.github.rvesse.airline.help.cli.CliGlobalUsageSummaryGenerator
- CliGlobalUsageSummaryGenerator(int) - Constructor for class com.github.rvesse.airline.help.cli.CliGlobalUsageSummaryGenerator
- CliGlobalUsageSummaryGenerator(int, boolean) - Constructor for class com.github.rvesse.airline.help.cli.CliGlobalUsageSummaryGenerator
- CliGlobalUsageSummaryGenerator(int, Comparator<? super HelpHint>, Comparator<? super OptionMetadata>, Comparator<? super CommandMetadata>, Comparator<? super CommandGroupMetadata>, boolean) - Constructor for class com.github.rvesse.airline.help.cli.CliGlobalUsageSummaryGenerator
- CliParser<T> - Class in com.github.rvesse.airline.parser.command
- CliParser() - Constructor for class com.github.rvesse.airline.parser.command.CliParser
- CliUsageHelper - Class in com.github.rvesse.airline.help.cli
- CliUsageHelper(Comparator<? super OptionMetadata>, boolean) - Constructor for class com.github.rvesse.airline.help.cli.CliUsageHelper
- close() - Method in class com.github.rvesse.airline.io.output.AnsiOutputStream
- close() - Method in class com.github.rvesse.airline.io.printers.UsagePrinter
- close() - Method in class com.github.rvesse.airline.io.writers.AnsiWriter
- close() - Method in class com.github.rvesse.airline.parser.resources.jpms.ScanResultInputStream
- cls - Variable in class com.github.rvesse.airline.utils.comparators.AbstractObjectComparator
- cls - Variable in class com.github.rvesse.airline.utils.predicates.parser.CommandTypeFinder
- codes() - Method in annotation type com.github.rvesse.airline.annotations.help.ExitCodes
-
The exit codes that this command may return, meanings of the exit codes may be given using the
ExitCodes.descriptions()
property. - collator - Variable in class com.github.rvesse.airline.utils.comparators.LexicalComparator
- collator - Variable in class com.github.rvesse.airline.utils.predicates.AbstractLocaleSensitiveStringFinder
- CollectAll - Class in com.github.rvesse.airline.parser.errors.handlers
-
Error handler which collects all the errors for later inspection
- CollectAll() - Constructor for class com.github.rvesse.airline.parser.errors.handlers.CollectAll
- collectPartial(Map<Class<? extends Annotation>, Set<Integer>>, Partial) - Static method in class com.github.rvesse.airline.model.MetadataLoader
- ColonSeparatedOptionParser<T> - Class in com.github.rvesse.airline.examples.userguide.parser.options
-
An option parser where the name and value are colon separated i.e.
- ColonSeparatedOptionParser() - Constructor for class com.github.rvesse.airline.examples.userguide.parser.options.ColonSeparatedOptionParser
-
Creates a new parser instance
- color - Variable in class com.github.rvesse.airline.examples.io.Colors256
- color - Variable in class com.github.rvesse.airline.io.colors.Color256
- COLOR_MODE_256 - Static variable in class com.github.rvesse.airline.io.AnsiControlCodes
-
256 colour extended colour mode
- COLOR_MODE_TRUE - Static variable in class com.github.rvesse.airline.io.AnsiControlCodes
-
24 bit extended colour mode
- Color256 - Class in com.github.rvesse.airline.io.colors
-
256 colour i.e.
- Color256(int) - Constructor for class com.github.rvesse.airline.io.colors.Color256
- ColorDemo<T> - Class in com.github.rvesse.airline.examples.io
- ColorDemo() - Constructor for class com.github.rvesse.airline.examples.io.ColorDemo
- ColorizedOutputStream<T> - Class in com.github.rvesse.airline.io.output
-
An output stream that supports colorization and some basic text decorations
- ColorizedOutputStream(OutputStream, ControlCodeSource<T>, ControlCodeSource<T>) - Constructor for class com.github.rvesse.airline.io.output.ColorizedOutputStream
- ColorizedWriter<T> - Class in com.github.rvesse.airline.io.writers
-
An writer stream that supports colorization and basic text decorations
- ColorizedWriter(Writer, ControlCodeSource<T>, ControlCodeSource<T>) - Constructor for class com.github.rvesse.airline.io.writers.ColorizedWriter
- Colors256 - Class in com.github.rvesse.airline.examples.io
- Colors256() - Constructor for class com.github.rvesse.airline.examples.io.Colors256
- ColorsBasic - Class in com.github.rvesse.airline.examples.io
- ColorsBasic() - Constructor for class com.github.rvesse.airline.examples.io.ColorsBasic
- ColorsTrue - Class in com.github.rvesse.airline.examples.io
- ColorsTrue() - Constructor for class com.github.rvesse.airline.examples.io.ColorsTrue
- columns - Variable in class com.github.rvesse.airline.help.common.AbstractPrintedGlobalUsageGenerator
- columns - Variable in class com.github.rvesse.airline.prompts.builders.ListFormatBuilder
- columns - Variable in class com.github.rvesse.airline.prompts.formatters.ListFormat
- columns - Variable in class com.github.rvesse.airline.prompts.formatters.QuestionFormat
- columnSize - Variable in class com.github.rvesse.airline.help.common.AbstractPrintedCommandGroupUsageGenerator
- columnSize - Variable in class com.github.rvesse.airline.help.common.AbstractPrintedCommandUsageGenerator
- COM_GOOGLE_INJECT_INJECT - Static variable in class com.github.rvesse.airline.model.MetadataLoader
-
Constant for the
com.google.inject.Inject
annotation class - com.github.rvesse.airline - module com.github.rvesse.airline
-
Copyright (C) 2010-16 the original author or authors.
- com.github.rvesse.airline - package com.github.rvesse.airline
- com.github.rvesse.airline.annotations - package com.github.rvesse.airline.annotations
- com.github.rvesse.airline.annotations.help - package com.github.rvesse.airline.annotations.help
- com.github.rvesse.airline.annotations.help.bash - package com.github.rvesse.airline.annotations.help.bash
- com.github.rvesse.airline.annotations.help.external - package com.github.rvesse.airline.annotations.help.external
- com.github.rvesse.airline.annotations.restrictions - package com.github.rvesse.airline.annotations.restrictions
- com.github.rvesse.airline.annotations.restrictions.global - package com.github.rvesse.airline.annotations.restrictions.global
- com.github.rvesse.airline.annotations.restrictions.ranges - package com.github.rvesse.airline.annotations.restrictions.ranges
- com.github.rvesse.airline.builder - package com.github.rvesse.airline.builder
- com.github.rvesse.airline.examples - module com.github.rvesse.airline.examples
-
Copyright (C) 2010-16 the original author or authors.
- com.github.rvesse.airline.examples - package com.github.rvesse.airline.examples
- com.github.rvesse.airline.examples.cli - package com.github.rvesse.airline.examples.cli
- com.github.rvesse.airline.examples.cli.aliases - package com.github.rvesse.airline.examples.cli.aliases
- com.github.rvesse.airline.examples.cli.commands - package com.github.rvesse.airline.examples.cli.commands
- com.github.rvesse.airline.examples.help - package com.github.rvesse.airline.examples.help
- com.github.rvesse.airline.examples.inheritance - package com.github.rvesse.airline.examples.inheritance
- com.github.rvesse.airline.examples.io - package com.github.rvesse.airline.examples.io
- com.github.rvesse.airline.examples.modules - package com.github.rvesse.airline.examples.modules
- com.github.rvesse.airline.examples.sendit - package com.github.rvesse.airline.examples.sendit
- com.github.rvesse.airline.examples.simple - package com.github.rvesse.airline.examples.simple
- com.github.rvesse.airline.examples.userguide - package com.github.rvesse.airline.examples.userguide
- com.github.rvesse.airline.examples.userguide.help.bash - package com.github.rvesse.airline.examples.userguide.help.bash
- com.github.rvesse.airline.examples.userguide.help.sections - package com.github.rvesse.airline.examples.userguide.help.sections
- com.github.rvesse.airline.examples.userguide.help.sections.custom - package com.github.rvesse.airline.examples.userguide.help.sections.custom
- com.github.rvesse.airline.examples.userguide.parser - package com.github.rvesse.airline.examples.userguide.parser
- com.github.rvesse.airline.examples.userguide.parser.options - package com.github.rvesse.airline.examples.userguide.parser.options
- com.github.rvesse.airline.examples.userguide.practise - package com.github.rvesse.airline.examples.userguide.practise
- com.github.rvesse.airline.examples.userguide.prompts - package com.github.rvesse.airline.examples.userguide.prompts
- com.github.rvesse.airline.examples.userguide.restrictions - package com.github.rvesse.airline.examples.userguide.restrictions
- com.github.rvesse.airline.examples.userguide.restrictions.custom - package com.github.rvesse.airline.examples.userguide.restrictions.custom
- com.github.rvesse.airline.help - package com.github.rvesse.airline.help
- com.github.rvesse.airline.help.bash - module com.github.rvesse.airline.help.bash
-
Copyright (C) 2010-16 the original author or authors.
- com.github.rvesse.airline.help.cli - package com.github.rvesse.airline.help.cli
- com.github.rvesse.airline.help.cli.bash - package com.github.rvesse.airline.help.cli.bash
- com.github.rvesse.airline.help.common - package com.github.rvesse.airline.help.common
- com.github.rvesse.airline.help.external - module com.github.rvesse.airline.help.external
-
Copyright (C) 2010-16 the original author or authors.
- com.github.rvesse.airline.help.external.factories - package com.github.rvesse.airline.help.external.factories
- com.github.rvesse.airline.help.external.parsers - package com.github.rvesse.airline.help.external.parsers
- com.github.rvesse.airline.help.external.parsers.defaults - package com.github.rvesse.airline.help.external.parsers.defaults
- com.github.rvesse.airline.help.html - module com.github.rvesse.airline.help.html
-
Copyright (C) 2010-16 the original author or authors.
- com.github.rvesse.airline.help.html - package com.github.rvesse.airline.help.html
- com.github.rvesse.airline.help.man - module com.github.rvesse.airline.help.man
-
Copyright (C) 2010-16 the original author or authors.
- com.github.rvesse.airline.help.man - package com.github.rvesse.airline.help.man
- com.github.rvesse.airline.help.markdown - module com.github.rvesse.airline.help.markdown
-
Copyright (C) 2010-16 the original author or authors.
- com.github.rvesse.airline.help.markdown - package com.github.rvesse.airline.help.markdown
- com.github.rvesse.airline.help.sections - package com.github.rvesse.airline.help.sections
- com.github.rvesse.airline.help.sections.common - package com.github.rvesse.airline.help.sections.common
- com.github.rvesse.airline.help.sections.factories - package com.github.rvesse.airline.help.sections.factories
- com.github.rvesse.airline.help.suggester - package com.github.rvesse.airline.help.suggester
- com.github.rvesse.airline.io - module com.github.rvesse.airline.io
-
Copyright (C) 2010-16 the original author or authors.
- com.github.rvesse.airline.io - package com.github.rvesse.airline.io
- com.github.rvesse.airline.io.colors - package com.github.rvesse.airline.io.colors
- com.github.rvesse.airline.io.colors.sources - package com.github.rvesse.airline.io.colors.sources
- com.github.rvesse.airline.io.decorations - package com.github.rvesse.airline.io.decorations
- com.github.rvesse.airline.io.decorations.sources - package com.github.rvesse.airline.io.decorations.sources
- com.github.rvesse.airline.io.output - package com.github.rvesse.airline.io.output
- com.github.rvesse.airline.io.printers - package com.github.rvesse.airline.io.printers
- com.github.rvesse.airline.io.writers - package com.github.rvesse.airline.io.writers
- com.github.rvesse.airline.jpms.debug - module com.github.rvesse.airline.jpms.debug
-
Copyright (C) 2010-16 the original author or authors.
- com.github.rvesse.airline.jpms.debug - package com.github.rvesse.airline.jpms.debug
- com.github.rvesse.airline.jpms.resources - module com.github.rvesse.airline.jpms.resources
-
Copyright (C) 2010-16 the original author or authors.
- com.github.rvesse.airline.model - package com.github.rvesse.airline.model
- com.github.rvesse.airline.parser - package com.github.rvesse.airline.parser
- com.github.rvesse.airline.parser.aliases - package com.github.rvesse.airline.parser.aliases
- com.github.rvesse.airline.parser.command - package com.github.rvesse.airline.parser.command
- com.github.rvesse.airline.parser.errors - package com.github.rvesse.airline.parser.errors
- com.github.rvesse.airline.parser.errors.handlers - package com.github.rvesse.airline.parser.errors.handlers
- com.github.rvesse.airline.parser.options - package com.github.rvesse.airline.parser.options
- com.github.rvesse.airline.parser.resources - package com.github.rvesse.airline.parser.resources
- com.github.rvesse.airline.parser.resources.jpms - package com.github.rvesse.airline.parser.resources.jpms
- com.github.rvesse.airline.parser.suggester - package com.github.rvesse.airline.parser.suggester
- com.github.rvesse.airline.prompts - module com.github.rvesse.airline.prompts
-
Copyright (C) 2010-16 the original author or authors.
- com.github.rvesse.airline.prompts - package com.github.rvesse.airline.prompts
- com.github.rvesse.airline.prompts.builders - package com.github.rvesse.airline.prompts.builders
- com.github.rvesse.airline.prompts.console - package com.github.rvesse.airline.prompts.console
- com.github.rvesse.airline.prompts.errors - package com.github.rvesse.airline.prompts.errors
- com.github.rvesse.airline.prompts.formatters - package com.github.rvesse.airline.prompts.formatters
- com.github.rvesse.airline.prompts.matchers - package com.github.rvesse.airline.prompts.matchers
- com.github.rvesse.airline.restrictions - package com.github.rvesse.airline.restrictions
- com.github.rvesse.airline.restrictions.common - package com.github.rvesse.airline.restrictions.common
- com.github.rvesse.airline.restrictions.factories - package com.github.rvesse.airline.restrictions.factories
- com.github.rvesse.airline.restrictions.global - package com.github.rvesse.airline.restrictions.global
- com.github.rvesse.airline.restrictions.options - package com.github.rvesse.airline.restrictions.options
- com.github.rvesse.airline.types - package com.github.rvesse.airline.types
- com.github.rvesse.airline.types.numerics - package com.github.rvesse.airline.types.numerics
- com.github.rvesse.airline.types.numerics.abbreviated - package com.github.rvesse.airline.types.numerics.abbreviated
- com.github.rvesse.airline.types.numerics.bases - package com.github.rvesse.airline.types.numerics.bases
- com.github.rvesse.airline.utils - package com.github.rvesse.airline.utils
- com.github.rvesse.airline.utils.comparators - package com.github.rvesse.airline.utils.comparators
- com.github.rvesse.airline.utils.predicates - package com.github.rvesse.airline.utils.predicates
- com.github.rvesse.airline.utils.predicates.parser - package com.github.rvesse.airline.utils.predicates.parser
- com.github.rvesse.airline.utils.predicates.restrictions - package com.github.rvesse.airline.utils.predicates.restrictions
- command - Variable in class com.github.rvesse.airline.help.Help
- command - Variable in class com.github.rvesse.airline.help.suggester.CommandSuggester
- command - Variable in class com.github.rvesse.airline.parser.ParseState
- command() - Method in annotation type com.github.rvesse.airline.annotations.help.bash.BashCompletion
-
Provides a command used to generate the completion words for this option
- Command - Annotation Type in com.github.rvesse.airline.annotations
-
Marks a class as a command
- COMMAND - com.github.rvesse.airline.annotations.OptionType
- COMMAND - com.github.rvesse.airline.Context
- commandComparator - Variable in class com.github.rvesse.airline.help.common.AbstractUsageGenerator
- commandFactory - Variable in class com.github.rvesse.airline.builder.ParserBuilder
- commandFactory - Variable in class com.github.rvesse.airline.model.ParserMetadata
- commandFactory() - Method in annotation type com.github.rvesse.airline.annotations.Parser
-
Sets the command factory class to use
- CommandFactory<T> - Interface in com.github.rvesse.airline
-
Interface for command factories
- CommandFinder - Class in com.github.rvesse.airline.utils.predicates.parser
- CommandFinder(String) - Constructor for class com.github.rvesse.airline.utils.predicates.parser.CommandFinder
- commandGroupComparator - Variable in class com.github.rvesse.airline.help.common.AbstractGlobalUsageGenerator
- CommandGroupMetadata - Class in com.github.rvesse.airline.model
-
Represents meta-data about a command group
- CommandGroupMetadata(String, String, boolean, Iterable<OptionMetadata>, Iterable<CommandGroupMetadata>, CommandMetadata, Iterable<CommandMetadata>) - Constructor for class com.github.rvesse.airline.model.CommandGroupMetadata
- commandGroups - Variable in class com.github.rvesse.airline.model.GlobalMetadata
- CommandGroupUsageGenerator<T> - Interface in com.github.rvesse.airline.help
-
Interface implemented by classes that can generate usage documentation for a command group
- commandMetadata - Variable in class com.github.rvesse.airline.HelpOption
- commandMetadata - Variable in class com.github.rvesse.airline.SingleCommand
- CommandMetadata - Class in com.github.rvesse.airline.model
- CommandMetadata(String, String, boolean, Iterable<OptionMetadata>, Iterable<OptionMetadata>, Iterable<OptionMetadata>, OptionMetadata, ArgumentsMetadata, Iterable<Accessor>, Class<?>, List<String>, List<Group>, List<HelpSection>) - Constructor for class com.github.rvesse.airline.model.CommandMetadata
- commandNames - Variable in class com.github.rvesse.airline.examples.cli.commands.Help
- commandOptions - Variable in class com.github.rvesse.airline.model.CommandMetadata
- commandOptions - Variable in class com.github.rvesse.airline.model.MetadataLoader.InjectionMetadata
- CommandRequired - Annotation Type in com.github.rvesse.airline.annotations.restrictions.global
-
Marks that a CLI requires that a command be specified.
- CommandRequiredRestriction - Class in com.github.rvesse.airline.restrictions.global
- CommandRequiredRestriction() - Constructor for class com.github.rvesse.airline.restrictions.global.CommandRequiredRestriction
- commands - Variable in class com.github.rvesse.airline.builder.GroupBuilder
- commands - Variable in class com.github.rvesse.airline.model.CommandGroupMetadata
- commands() - Method in annotation type com.github.rvesse.airline.annotations.Cli
-
Defines the classes that provide top-level commands for the CLI
- commands() - Method in annotation type com.github.rvesse.airline.annotations.Group
-
Command classes to add to the group (optional)
- commands() - Method in annotation type com.github.rvesse.airline.examples.userguide.help.sections.custom.RelatedCommands
-
Provides a list of related commands
- CommandSuggester - Class in com.github.rvesse.airline.help.suggester
- CommandSuggester() - Constructor for class com.github.rvesse.airline.help.suggester.CommandSuggester
- CommandTypeFinder - Class in com.github.rvesse.airline.utils.predicates.parser
- CommandTypeFinder(Class<?>) - Constructor for class com.github.rvesse.airline.utils.predicates.parser.CommandTypeFinder
- commandUsageGenerator - Variable in class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator
- commandUsageGenerator - Variable in class com.github.rvesse.airline.help.markdown.MarkdownGlobalUsageGenerator
- CommandUsageGenerator - Interface in com.github.rvesse.airline.help
-
Interface implemented by classes that can generate usage documentation for a command
- CommonSections - Class in com.github.rvesse.airline.help.sections.common
-
Constants related to common help sections
- CommonSections() - Constructor for class com.github.rvesse.airline.help.sections.common.CommonSections
- CommonSectionsFactory - Class in com.github.rvesse.airline.help.sections.factories
-
A help section factory that implements the common sections built into Airline
- CommonSectionsFactory() - Constructor for class com.github.rvesse.airline.help.sections.factories.CommonSectionsFactory
- compact() - Method in class com.github.rvesse.airline.model.MetadataLoader.InjectionMetadata
- comparator - Variable in class com.github.rvesse.airline.restrictions.common.RangeRestriction
- compare(HelpSection, HelpSection) - Method in class com.github.rvesse.airline.utils.comparators.HelpSectionComparator
- compare(Object, Object) - Method in class com.github.rvesse.airline.utils.comparators.AbstractObjectComparator
- compare(String, String) - Method in class com.github.rvesse.airline.utils.comparators.StringHierarchyComparator
- compareClasses(Class<?>, Class<?>) - Method in class com.github.rvesse.airline.utils.comparators.AbstractObjectComparator
- comparePossibleValues(T, T) - Method in class com.github.rvesse.airline.utils.comparators.AbstractObjectComparator
- compareTo(PortRange) - Method in class com.github.rvesse.airline.restrictions.common.PortRangeImpl
- compareValues(Double, Double) - Method in class com.github.rvesse.airline.utils.comparators.DoubleComparator
- compareValues(Float, Float) - Method in class com.github.rvesse.airline.utils.comparators.FloatComparator
- compareValues(String, String) - Method in class com.github.rvesse.airline.utils.comparators.LexicalComparator
- compareValues(T, T) - Method in class com.github.rvesse.airline.utils.comparators.AbstractComparableComparator
- compareValues(T, T) - Method in class com.github.rvesse.airline.utils.comparators.AbstractObjectComparator
- CompletionBehaviour - Enum in com.github.rvesse.airline.help.cli.bash
-
Possible completion behaviour for options/arguments
- CompletionBehaviour() - Constructor for enum com.github.rvesse.airline.help.cli.bash.CompletionBehaviour
- CompletionCli - Class in com.github.rvesse.airline.examples.cli
-
An example of creating a CLI using command groups
- CompletionCli() - Constructor for class com.github.rvesse.airline.examples.cli.CompletionCli
- ComplexNumericTypeConverter - Class in com.github.rvesse.airline.types.numerics
-
Abstract numeric type converter that supports numerics given in the form
1234suffix
wheresuffix
denotes some multiplier. - ComplexNumericTypeConverter() - Constructor for class com.github.rvesse.airline.types.numerics.ComplexNumericTypeConverter
- component - Variable in class com.github.rvesse.airline.help.sections.common.VersionSection.VersionInfo
- componentProperty() - Method in annotation type com.github.rvesse.airline.annotations.help.Version
-
Sets the property used to find the component information (if any)
- compositionAnnotationClasses - Variable in class com.github.rvesse.airline.model.ParserMetadata
- compositionAnnotationClasses() - Method in annotation type com.github.rvesse.airline.annotations.Parser
-
Sets the composition annotation classes to use.
- CONCEAL - com.github.rvesse.airline.io.decorations.BasicDecoration
- CONCEAL - Static variable in class com.github.rvesse.airline.io.AnsiControlCodes
- console - Variable in class com.github.rvesse.airline.prompts.console.ConsolePrompt
- ConsolePrompt - Class in com.github.rvesse.airline.prompts.console
-
A prompt that is backed by
System.console()
- ConsolePrompt() - Constructor for class com.github.rvesse.airline.prompts.console.ConsolePrompt
-
Creates a new console prompt using the default
System.console()
- ConsolePrompt(Console) - Constructor for class com.github.rvesse.airline.prompts.console.ConsolePrompt
-
Creates a new console prompt using the specified console
- contains(PortRange) - Method in enum com.github.rvesse.airline.annotations.restrictions.PortType
- contains(PortRange) - Method in interface com.github.rvesse.airline.restrictions.common.PortRange
-
Gets whether the port range contains another port range i.e.
- contains(PortRange) - Method in class com.github.rvesse.airline.restrictions.common.PortRangeImpl
- Context - Enum in com.github.rvesse.airline
- Context() - Constructor for enum com.github.rvesse.airline.Context
- ControlCodeSource<T> - Interface in com.github.rvesse.airline.io
-
Interface for classes that provide control codes
- controls - Variable in class com.github.rvesse.airline.io.output.AnsiOutputStream
- controls - Variable in class com.github.rvesse.airline.io.writers.AnsiWriter
- ControlTracker<T> - Class in com.github.rvesse.airline.io
-
Class used to track the state of a control allowing it to be lazily written to the output only if necessary and ensuring it can be appropriately reset when necessary
- ControlTracker(ControlCodeSource<T>) - Constructor for class com.github.rvesse.airline.io.ControlTracker
- convert(String, Class<?>, String) - Method in class com.github.rvesse.airline.examples.userguide.practise.ExtendedTypeConverter
- convert(String, Class<?>, String) - Method in class com.github.rvesse.airline.types.DefaultTypeConverter
- convert(String, Class<?>, String) - Method in interface com.github.rvesse.airline.types.TypeConverter
-
Convert a string value into an appropriately typed value
- converter - Variable in class com.github.rvesse.airline.prompts.builders.PromptBuilder
- converter - Variable in class com.github.rvesse.airline.prompts.Prompt
- ConvertResult - Class in com.github.rvesse.airline.types
-
Helper class used to represent the result of an attempted conversion.
- ConvertResult() - Constructor for class com.github.rvesse.airline.types.ConvertResult
-
Creates a basic convert result that indicates failure
- ConvertResult(Object) - Constructor for class com.github.rvesse.airline.types.ConvertResult
-
Creates a new conversion result that indicates success
- ConvertResult(Throwable) - Constructor for class com.github.rvesse.airline.types.ConvertResult
-
Creates a new conversion result that indicates failure
- Copyright - Annotation Type in com.github.rvesse.airline.annotations.help
-
Annotation that provides a copyright statement in a commands help
- create(MultipleOf) - Method in class com.github.rvesse.airline.examples.userguide.restrictions.custom.MultipleRestrictionFactory
- createAllowedValues(ParseState<T>, String, Class<?>, TypeConverter) - Method in class com.github.rvesse.airline.restrictions.common.AllowedValuesRestriction
- createArgumentsRestriction(Annotation) - Method in class com.github.rvesse.airline.examples.userguide.restrictions.custom.MultipleRestrictionFactory
- createArgumentsRestriction(Annotation) - Method in class com.github.rvesse.airline.restrictions.factories.AllowedValuesRestrictionFactory
- createArgumentsRestriction(Annotation) - Method in interface com.github.rvesse.airline.restrictions.factories.ArgumentsRestrictionFactory
-
Tries to create an arguments restriction from the given annotation
- createArgumentsRestriction(Annotation) - Method in class com.github.rvesse.airline.restrictions.factories.OccurrencesRestrictionFactory
- createArgumentsRestriction(Annotation) - Method in class com.github.rvesse.airline.restrictions.factories.PathRestrictionFactory
- createArgumentsRestriction(Annotation) - Method in class com.github.rvesse.airline.restrictions.factories.PortRestrictionFactory
- createArgumentsRestriction(Annotation) - Method in class com.github.rvesse.airline.restrictions.factories.RangeRestrictionFactory
- createArgumentsRestriction(Annotation) - Method in class com.github.rvesse.airline.restrictions.factories.RequireFromRestrictionFactory
- createArgumentsRestriction(Annotation) - Method in class com.github.rvesse.airline.restrictions.factories.SimpleRestrictionsFactory
- createArgumentsRestriction(Annotation) - Method in class com.github.rvesse.airline.restrictions.factories.StringRestrictionFactory
- createByteRange(Annotation) - Method in class com.github.rvesse.airline.restrictions.factories.RangeRestrictionFactory
- createCommandFile(GlobalMetadata<T>, String[], CommandMetadata) - Method in class com.github.rvesse.airline.help.man.ManMultiPageGlobalUsageGenerator
- createCommandFile(GlobalMetadata<T>, String[], CommandMetadata) - Method in class com.github.rvesse.airline.help.markdown.MarkdownMultiPageGlobalUsageGenerator
- createCommon(Port) - Method in class com.github.rvesse.airline.restrictions.factories.PortRestrictionFactory
- createCommon(PortRange...) - Method in class com.github.rvesse.airline.restrictions.factories.PortRestrictionFactory
- createCommon(Annotation) - Method in class com.github.rvesse.airline.restrictions.factories.AllowedValuesRestrictionFactory
- createCommon(Annotation) - Method in class com.github.rvesse.airline.restrictions.factories.OccurrencesRestrictionFactory
- createCommon(Annotation) - Method in class com.github.rvesse.airline.restrictions.factories.PathRestrictionFactory
- createCommon(Annotation) - Method in class com.github.rvesse.airline.restrictions.factories.RangeRestrictionFactory
-
Handles converting all the basic range annotations into appropriate range restrictions
- createCommon(Annotation) - Method in class com.github.rvesse.airline.restrictions.factories.SimpleRestrictionsFactory
- createCommon(Annotation) - Method in class com.github.rvesse.airline.restrictions.factories.StringRestrictionFactory
- createDoubleRange(Annotation) - Method in class com.github.rvesse.airline.restrictions.factories.RangeRestrictionFactory
- createError() - Method in interface com.github.rvesse.airline.ChannelFactory
-
Returns error channel.
- createError() - Method in class com.github.rvesse.airline.SystemChannelFactory
- createFloatRange(Annotation) - Method in class com.github.rvesse.airline.restrictions.factories.RangeRestrictionFactory
- createGlobalRestriction(Annotation) - Method in interface com.github.rvesse.airline.restrictions.factories.GlobalRestrictionFactory
-
Try and create a global restriction from the given annotation
- createGlobalRestriction(Annotation) - Method in class com.github.rvesse.airline.restrictions.factories.StandardGlobalRestrictionsFactory
- createGroupsFromAnnotations(List<CommandMetadata>, List<CommandMetadata>, List<CommandGroupMetadata>, List<CommandMetadata>, Map<String, HelpSection>, ParserMetadata<?>) - Static method in class com.github.rvesse.airline.model.MetadataLoader
- createHelper(boolean) - Method in class com.github.rvesse.airline.help.man.ManCommandUsageGenerator
- createHelper(boolean) - Method in class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator
- createHelper(Comparator<? super OptionMetadata>, boolean) - Method in class com.github.rvesse.airline.help.cli.CliCommandUsageGenerator
- createHelper(Comparator<? super OptionMetadata>, boolean) - Method in class com.github.rvesse.airline.help.cli.CliGlobalUsageGenerator
- createHelper(Comparator<? super OptionMetadata>, boolean) - Method in class com.github.rvesse.airline.help.cli.CliGlobalUsageSummaryGenerator
- createHelper(Comparator<? super OptionMetadata>, boolean) - Method in class com.github.rvesse.airline.help.markdown.MarkdownCommandUsageGenerator
- createHelper(Comparator<? super OptionMetadata>, boolean) - Method in class com.github.rvesse.airline.help.markdown.MarkdownGlobalUsageGenerator
- createInput() - Method in interface com.github.rvesse.airline.ChannelFactory
-
Returns input channel.
- createInput() - Method in class com.github.rvesse.airline.SystemChannelFactory
- createInstance(Class<?>) - Method in interface com.github.rvesse.airline.CommandFactory
-
Creates an instance of the given type
- createInstance(Class<?>) - Method in class com.github.rvesse.airline.DefaultCommandFactory
- createInstance(Class<?>, Iterable<OptionMetadata>, List<Pair<OptionMetadata, Object>>, ArgumentsMetadata, Iterable<Object>, Iterable<Accessor>, Map<Class<?>, Object>) - Static method in class com.github.rvesse.airline.parser.ParserUtil
- createInstance(Class<?>, Iterable<OptionMetadata>, List<Pair<OptionMetadata, Object>>, ArgumentsMetadata, Iterable<Object>, Iterable<Accessor>, Map<Class<?>, Object>, CommandFactory<T>) - Static method in class com.github.rvesse.airline.parser.ParserUtil
- createInstance(Class<T>) - Static method in class com.github.rvesse.airline.parser.ParserUtil
- createIntegerRange(Annotation) - Method in class com.github.rvesse.airline.restrictions.factories.RangeRestrictionFactory
- createLengthRange(Annotation) - Method in class com.github.rvesse.airline.restrictions.factories.RangeRestrictionFactory
- createLexicalRange(Annotation) - Method in class com.github.rvesse.airline.restrictions.factories.RangeRestrictionFactory
- createLongRange(Annotation) - Method in class com.github.rvesse.airline.restrictions.factories.RangeRestrictionFactory
- createOptionRestriction(Annotation) - Method in class com.github.rvesse.airline.examples.userguide.restrictions.custom.MultipleRestrictionFactory
- createOptionRestriction(Annotation) - Method in class com.github.rvesse.airline.restrictions.factories.AllowedValuesRestrictionFactory
- createOptionRestriction(Annotation) - Method in class com.github.rvesse.airline.restrictions.factories.OccurrencesRestrictionFactory
- createOptionRestriction(Annotation) - Method in interface com.github.rvesse.airline.restrictions.factories.OptionRestrictionFactory
-
Try and create an option restriction from the given annotation
- createOptionRestriction(Annotation) - Method in class com.github.rvesse.airline.restrictions.factories.PathRestrictionFactory
- createOptionRestriction(Annotation) - Method in class com.github.rvesse.airline.restrictions.factories.PortRestrictionFactory
- createOptionRestriction(Annotation) - Method in class com.github.rvesse.airline.restrictions.factories.RangeRestrictionFactory
- createOptionRestriction(Annotation) - Method in class com.github.rvesse.airline.restrictions.factories.RequiredOnlyIfRestrictionFactory
- createOptionRestriction(Annotation) - Method in class com.github.rvesse.airline.restrictions.factories.RequireFromRestrictionFactory
- createOptionRestriction(Annotation) - Method in class com.github.rvesse.airline.restrictions.factories.SimpleRestrictionsFactory
- createOptionRestriction(Annotation) - Method in class com.github.rvesse.airline.restrictions.factories.StringRestrictionFactory
- createOutput() - Method in interface com.github.rvesse.airline.ChannelFactory
-
Returns output channel.
- createOutput() - Method in class com.github.rvesse.airline.SystemChannelFactory
- createRange(PortRange) - Method in class com.github.rvesse.airline.restrictions.factories.PortRestrictionFactory
- createResourceLocators(Class<? extends ResourceLocator>[]) - Static method in class com.github.rvesse.airline.parser.ParserUtil
- createRestrictions(Class<C>, Iterable<GlobalRestriction>) - Method in class com.github.rvesse.airline.SingleCommand
- createSection(Annotation) - Method in class com.github.rvesse.airline.examples.userguide.help.sections.custom.RelatedCommandsFactory
- createSection(Annotation) - Method in class com.github.rvesse.airline.help.external.factories.ExternalHelpFactory
- createSection(Annotation) - Method in class com.github.rvesse.airline.help.sections.factories.CommonSectionsFactory
- createSection(Annotation) - Method in interface com.github.rvesse.airline.help.sections.factories.HelpSectionFactory
-
Tries to create a section from the given annotation
- createShortRange(Annotation) - Method in class com.github.rvesse.airline.restrictions.factories.RangeRestrictionFactory
- createUnknownRange(Annotation) - Method in class com.github.rvesse.airline.restrictions.factories.RangeRestrictionFactory
-
Handles turning unknown annotations into range restrictions, derived factories can extend this to add support for additional range restrictions
- createUsagePrinter(OutputStream) - Method in class com.github.rvesse.airline.help.common.AbstractPrintedCommandGroupUsageGenerator
-
Creates a usage printer for the given stream
- createUsagePrinter(OutputStream) - Method in class com.github.rvesse.airline.help.common.AbstractPrintedCommandUsageGenerator
-
Creates a usage printer for the given stream
- createUsagePrinter(OutputStream) - Method in class com.github.rvesse.airline.help.common.AbstractPrintedGlobalUsageGenerator
-
Creates a usage printer for the given stream
- credentials - Variable in class com.github.rvesse.airline.examples.modules.Modules
-
A field marked with
AirlineModule
will also be scanned for options - CredentialsModule - Class in com.github.rvesse.airline.examples.modules
- CredentialsModule() - Constructor for class com.github.rvesse.airline.examples.modules.CredentialsModule
- current - Variable in class com.github.rvesse.airline.io.ControlTracker
- currentOption - Variable in class com.github.rvesse.airline.parser.ParseState
- currentPosition - Variable in class com.github.rvesse.airline.io.printers.UsagePrinter
- currentState - Variable in class com.github.rvesse.airline.restrictions.common.AllowedValuesRestriction
- CustomHelp - Class in com.github.rvesse.airline.examples.help
- CustomHelp() - Constructor for class com.github.rvesse.airline.examples.help.CustomHelp
- CYAN - com.github.rvesse.airline.io.colors.BasicColor
D
- DASH - com.github.rvesse.airline.io.printers.TroffPrinter.BulletStyle
- date - Variable in class com.github.rvesse.airline.help.sections.common.VersionSection.VersionInfo
- dateProperty() - Method in annotation type com.github.rvesse.airline.annotations.help.Version
-
Sets the property used to find build date information (if any)
- Debug - Class in com.github.rvesse.airline.jpms.debug
- Debug() - Constructor for class com.github.rvesse.airline.jpms.debug.Debug
- Decorations - Class in com.github.rvesse.airline.examples.io
- Decorations() - Constructor for class com.github.rvesse.airline.examples.io.Decorations
- DEFAULT_ARGUMENTS_SEPARATOR - Static variable in class com.github.rvesse.airline.model.ParserMetadata
-
Default separator used to separate arguments from options
- DEFAULT_BACKGROUND - Static variable in class com.github.rvesse.airline.io.AnsiControlCodes
-
Control code for resetting the background colour to the default
- DEFAULT_COLUMNS - Static variable in class com.github.rvesse.airline.help.common.AbstractUsageGenerator
- DEFAULT_COLUMNS - Static variable in class com.github.rvesse.airline.prompts.builders.ListFormatBuilder
-
Default columns used to display list options
- DEFAULT_COMMAND_COMPARATOR - Static variable in class com.github.rvesse.airline.help.UsageHelper
-
Default comparator for commands
- DEFAULT_COMMAND_GROUP_COMPARATOR - Static variable in class com.github.rvesse.airline.help.UsageHelper
- DEFAULT_EXIT_CODE_COMPARATOR - Static variable in class com.github.rvesse.airline.help.UsageHelper
-
Default comparator for exit codes
- DEFAULT_EXTENSION - Static variable in class com.github.rvesse.airline.builder.UserAliasSourceBuilder
- DEFAULT_FOREGROUND - Static variable in class com.github.rvesse.airline.io.AnsiControlCodes
-
Control code for resetting the foreground colour to the default
- DEFAULT_HINT_COMPARATOR - Static variable in class com.github.rvesse.airline.help.UsageHelper
-
Default comparator for help hints
- DEFAULT_INDENTATION - Static variable in class com.github.rvesse.airline.io.printers.TroffPrinter
- DEFAULT_LOCATORS - Static variable in class com.github.rvesse.airline.parser.aliases.UserAliasesSource
-
Default user alias source locators
- DEFAULT_OPTION_COMPARATOR - Static variable in class com.github.rvesse.airline.help.UsageHelper
-
Default comparator for options
- DEFAULT_SEPARATOR - Static variable in class com.github.rvesse.airline.parser.options.AbstractNameValueOptionParser
- DEFAULT_SEPARATOR - Static variable in class com.github.rvesse.airline.parser.options.ListValueOptionParser
- DEFAULT_SEPARATOR - Static variable in class com.github.rvesse.airline.parser.options.MaybePairValueOptionParser
- DEFAULT_STYLESHEET - Static variable in class com.github.rvesse.airline.help.html.HtmlCommandUsageGenerator
-
Default stylesheet (Bootstrap)
- DEFAULT_TYPE_CONVERTER - Static variable in class com.github.rvesse.airline.parser.AbstractParser
-
Default type converter
- defaultAliasLocatorsFirst() - Method in annotation type com.github.rvesse.airline.annotations.Parser
-
Sets whether to use the default alias locators first before any additional alias locators that may be defined (default false)
- DefaultCli - Class in com.github.rvesse.airline.examples.cli
-
An example of creating a CLI that includes a default command that is run if no command is specified
- DefaultCli() - Constructor for class com.github.rvesse.airline.examples.cli.DefaultCli
- defaultCommand - Variable in class com.github.rvesse.airline.builder.CliBuilder
- defaultCommand - Variable in class com.github.rvesse.airline.builder.GroupBuilder
- defaultCommand - Variable in class com.github.rvesse.airline.model.CommandGroupMetadata
- defaultCommand - Variable in class com.github.rvesse.airline.model.GlobalMetadata
- defaultCommand() - Method in annotation type com.github.rvesse.airline.annotations.Cli
-
Defines the class that provides the default command for the CLI
- defaultCommand() - Method in annotation type com.github.rvesse.airline.annotations.Group
-
Default command class for the group (optional)
- DefaultCommandFactory<T> - Class in com.github.rvesse.airline
- DefaultCommandFactory() - Constructor for class com.github.rvesse.airline.DefaultCommandFactory
- defaultCommandGroupCommands - Variable in class com.github.rvesse.airline.builder.CliBuilder
- defaultConfiguration() - Static method in class com.github.rvesse.airline.builder.ParserBuilder
-
Gets the default configuration
- DefaultExternalHelpParser - Class in com.github.rvesse.airline.help.external.parsers.defaults
-
Default external help parser
- DefaultExternalHelpParser() - Constructor for class com.github.rvesse.airline.help.external.parsers.defaults.DefaultExternalHelpParser
- defaultGroupCommands - Variable in class com.github.rvesse.airline.model.GlobalMetadata
- DefaultMatcher<TOption> - Class in com.github.rvesse.airline.prompts.matchers
-
Default prompt option matcher
- DefaultMatcher() - Constructor for class com.github.rvesse.airline.prompts.matchers.DefaultMatcher
- DefaultNumericConverter - Class in com.github.rvesse.airline.types.numerics
- DefaultNumericConverter() - Constructor for class com.github.rvesse.airline.types.numerics.DefaultNumericConverter
- defaultOption - Variable in class com.github.rvesse.airline.model.CommandMetadata
- defaultOption - Variable in class com.github.rvesse.airline.model.MetadataLoader.InjectionMetadata
- DefaultOption - Annotation Type in com.github.rvesse.airline.annotations
-
Annotation to mark a field as the default option
- defaultParser - Variable in class com.github.rvesse.airline.help.external.factories.ExternalHelpFactory
- defaultParsersFirst() - Method in annotation type com.github.rvesse.airline.annotations.Parser
-
Sets whether to use the default option parsers first before any additional option parsers that may be defined (default true)
- defaultPrompt() - Static method in class com.github.rvesse.airline.prompts.Prompts
-
Creates a simple prompt using the default provider (from
Prompts.defaultProvider()
- defaultProvider() - Static method in class com.github.rvesse.airline.prompts.Prompts
-
Gets the default provider
- DEFAULTS - Static variable in interface com.github.rvesse.airline.restrictions.GlobalRestriction
- DefaultTypeConverter - Class in com.github.rvesse.airline.types
-
The default type converter
- DefaultTypeConverter() - Constructor for class com.github.rvesse.airline.types.DefaultTypeConverter
- DefaultTypeConverter(NumericTypeConverter) - Constructor for class com.github.rvesse.airline.types.DefaultTypeConverter
- DefaultTypeConverterProvider - Class in com.github.rvesse.airline.types
-
Default type converter provider which simply inspects the
ParseState
given and returns the the type converter specified on theParserMetadata
provided by the parse state - DefaultTypeConverterProvider() - Constructor for class com.github.rvesse.airline.types.DefaultTypeConverterProvider
- depth - Variable in class com.github.rvesse.airline.examples.sendit.Package
- description - Variable in class com.github.rvesse.airline.builder.CliBuilder
- description - Variable in class com.github.rvesse.airline.builder.GroupBuilder
- description - Variable in class com.github.rvesse.airline.model.ArgumentsMetadata
- description - Variable in class com.github.rvesse.airline.model.CommandGroupMetadata
- description - Variable in class com.github.rvesse.airline.model.CommandMetadata
- description - Variable in class com.github.rvesse.airline.model.GlobalMetadata
- description - Variable in class com.github.rvesse.airline.model.OptionMetadata
- description - Variable in class com.github.rvesse.airline.restrictions.common.PatternRestriction
- description() - Method in annotation type com.github.rvesse.airline.annotations.Arguments
-
A description of the arguments.
- description() - Method in annotation type com.github.rvesse.airline.annotations.Cli
-
Sets the description of the CLI
- description() - Method in annotation type com.github.rvesse.airline.annotations.Command
-
Description of the command
- description() - Method in annotation type com.github.rvesse.airline.annotations.Group
-
Description of the group.
- description() - Method in annotation type com.github.rvesse.airline.annotations.Option
-
A description of this option.
- description() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.Pattern
-
Provides a description describing the intent of the regular expression, this is often more helpful to end users than an error that their input did not match a regular expression when they may not understand regular expressions
- descriptions() - Method in annotation type com.github.rvesse.airline.annotations.help.Examples
-
An array of paragraphs of text where each paragraph described the corresponding example given in the
Examples.examples()
property. - descriptions() - Method in annotation type com.github.rvesse.airline.annotations.help.ExitCodes
-
Descriptions of the meanings of the exit codes this command may return, the exit codes are given by the
ExitCodes.codes()
property. - descriptionSource() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalExamples
-
Source containing the descriptions of the examples
- DIRECTORIES - com.github.rvesse.airline.help.cli.bash.CompletionBehaviour
-
Directories, use standard directory name completion if no other completions apply
- Directory - Annotation Type in com.github.rvesse.airline.annotations.restrictions
-
Annotation that marks that an options value must be a valid path to a directory
- DIRECTORY - com.github.rvesse.airline.annotations.restrictions.PathKind
-
Directory
- disableCode - Variable in enum com.github.rvesse.airline.io.decorations.BasicDecoration
- Discussed - Class in com.github.rvesse.airline.examples.userguide.help.sections
- Discussed() - Constructor for class com.github.rvesse.airline.examples.userguide.help.sections.Discussed
- Discussion - Annotation Type in com.github.rvesse.airline.annotations.help
-
Annotation that provides a discussion section for a commands help
- DiscussionSection - Class in com.github.rvesse.airline.help.sections.common
- DiscussionSection(String[]) - Constructor for class com.github.rvesse.airline.help.sections.common.DiscussionSection
- displayPrompt() - Method in class com.github.rvesse.airline.prompts.Prompt
-
Displays the prompt
- displayPrompt(Prompt<T>) - Method in class com.github.rvesse.airline.prompts.formatters.ListFormat
- displayPrompt(Prompt<T>) - Method in class com.github.rvesse.airline.prompts.formatters.QuestionFormat
- displayPrompt(Prompt<TOption>) - Method in interface com.github.rvesse.airline.prompts.formatters.PromptFormatter
-
Displays the prompt
- dot - Variable in class com.github.rvesse.airline.examples.simple.Paths
- DOUBLE_COMPARATOR - Static variable in class com.github.rvesse.airline.restrictions.factories.RangeRestrictionFactory
- DOUBLE_NEWLINE - Static variable in class com.github.rvesse.airline.help.cli.bash.BashCompletionGenerator
- DoubleComparator - Class in com.github.rvesse.airline.utils.comparators
- DoubleComparator() - Constructor for class com.github.rvesse.airline.utils.comparators.DoubleComparator
- DoubleRange - Annotation Type in com.github.rvesse.airline.annotations.restrictions.ranges
-
Annotation that marks values as being restricted to a given double range
- doubleRestrictor - Variable in class com.github.rvesse.airline.restrictions.common.PositiveNegativeRestriction
- DYNAMIC - com.github.rvesse.airline.annotations.restrictions.PortType
-
The dynamic ports (aka private or ephemeral ports), these are ports
49152
to65535
which are never assigned by the IANA - dynamicAnnotationCache - Static variable in class com.github.rvesse.airline.model.MetadataLoader
E
- EM_DASH - com.github.rvesse.airline.io.printers.TroffPrinter.BulletStyle
- empty - Variable in class com.github.rvesse.airline.examples.simple.Paths
- enableCode - Variable in enum com.github.rvesse.airline.io.decorations.BasicDecoration
- endList() - Method in class com.github.rvesse.airline.io.printers.TroffPrinter
- EndsWith - Annotation Type in com.github.rvesse.airline.annotations.restrictions
-
Annotation that marks that an options value must end with a given string
- EndsWithRestriction - Class in com.github.rvesse.airline.restrictions.common
-
A restriction that requires raw values to end with one of a set of suffixes
- EndsWithRestriction(boolean, Locale, String...) - Constructor for class com.github.rvesse.airline.restrictions.common.EndsWithRestriction
- endYear() - Method in annotation type com.github.rvesse.airline.annotations.help.Copyright
-
Gets/Sets the end year
- EnvVarLocator - Class in com.github.rvesse.airline.parser.resources
-
A resource locator that supports
${NAME}
style placeholders to refer to environment variables to locate resources referred to by those environment variables - EnvVarLocator() - Constructor for class com.github.rvesse.airline.parser.resources.EnvVarLocator
- envVars - Variable in class com.github.rvesse.airline.examples.simple.Paths
- equals(Object) - Method in class com.github.rvesse.airline.Accessor
- equals(Object) - Method in class com.github.rvesse.airline.io.colors.Color256
- equals(Object) - Method in class com.github.rvesse.airline.io.colors.TrueColor
- equals(Object) - Method in class com.github.rvesse.airline.model.ArgumentsMetadata
- equals(Object) - Method in class com.github.rvesse.airline.model.CommandMetadata
- equals(Object) - Method in class com.github.rvesse.airline.model.OptionMetadata
- error() - Static method in class com.github.rvesse.airline.Channels
-
Returns error channel.
- errorHandler - Variable in class com.github.rvesse.airline.builder.ParserBuilder
- errorHandler - Variable in class com.github.rvesse.airline.model.ParserMetadata
- errorHandler() - Method in annotation type com.github.rvesse.airline.annotations.Parser
-
Sets the error handler to use, defaults to
FailFast
which throws errors as soon as they are encountered - errors - Variable in class com.github.rvesse.airline.parser.errors.handlers.AbstractCollectingHandler
- errors - Variable in class com.github.rvesse.airline.parser.ParseResult
- escape(String) - Method in class com.github.rvesse.airline.io.printers.TroffPrinter
- ESCAPE - Static variable in class com.github.rvesse.airline.io.AnsiControlCodes
-
Standard ANSI escape sequence
- escapeArg(String) - Method in class com.github.rvesse.airline.io.printers.TroffPrinter
- evaluate(AliasMetadata) - Method in class com.github.rvesse.airline.utils.predicates.parser.AliasFinder
- evaluate(CommandGroupMetadata) - Method in class com.github.rvesse.airline.utils.predicates.parser.GroupFinder
- evaluate(CommandMetadata) - Method in class com.github.rvesse.airline.utils.predicates.parser.CommandFinder
- evaluate(CommandMetadata) - Method in class com.github.rvesse.airline.utils.predicates.parser.CommandTypeFinder
- evaluate(OptionMetadata) - Method in class com.github.rvesse.airline.utils.predicates.parser.OptionFinder
- evaluate(OptionMetadata) - Method in class com.github.rvesse.airline.utils.predicates.restrictions.AbstractOptionRestrictionBasedFinder
- evaluate(ArgumentsRestriction) - Method in class com.github.rvesse.airline.utils.predicates.restrictions.IsRequiredArgumentFinder
- evaluate(OptionRestriction) - Method in class com.github.rvesse.airline.utils.predicates.restrictions.AllowedValuesOptionFinder
- evaluate(OptionRestriction) - Method in class com.github.rvesse.airline.utils.predicates.restrictions.IsRequiredOptionFinder
- evaluate(OptionRestriction) - Method in class com.github.rvesse.airline.utils.predicates.restrictions.MutuallyExclusiveWithFinder
- evaluate(OptionRestriction) - Method in class com.github.rvesse.airline.utils.predicates.restrictions.RequiredFromFinder
- evaluate(String) - Method in class com.github.rvesse.airline.restrictions.options.RequiredUnlessEnvironmentRestriction.IsEnvVarSet
- evaluate(String) - Method in class com.github.rvesse.airline.utils.predicates.LocaleSensitiveStringFinder
- evaluate(String) - Method in class com.github.rvesse.airline.utils.predicates.PrefixMatcher
- evaluate(String) - Method in class com.github.rvesse.airline.utils.predicates.SuffixMatcher
- evaluate(Pair<OptionMetadata, Object>) - Method in class com.github.rvesse.airline.utils.predicates.parser.ParsedOptionFinder
- evaluate(Pair<OptionMetadata, Object>) - Method in class com.github.rvesse.airline.utils.predicates.restrictions.AbstractParsedOptionRestrictionBasedFinder
- evaluate(T) - Method in class com.github.rvesse.airline.utils.predicates.AbstractAbbreviationFinder
- evaluate(TOption) - Method in class com.github.rvesse.airline.prompts.matchers.MatcherUtils.Exact
- evaluate(TOption) - Method in class com.github.rvesse.airline.prompts.matchers.MatcherUtils.ExactIgnoresCase
- evaluate(TOption) - Method in class com.github.rvesse.airline.prompts.matchers.MatcherUtils.ExactOrStartsWith
- evaluate(TOption) - Method in class com.github.rvesse.airline.prompts.matchers.MatcherUtils.ExactOrStartsWithIgnoresCase
- exact - Variable in class com.github.rvesse.airline.utils.predicates.AbstractAbbreviationFinder
- Exact(String) - Constructor for class com.github.rvesse.airline.prompts.matchers.MatcherUtils.Exact
- ExactIgnoresCase(String) - Constructor for class com.github.rvesse.airline.prompts.matchers.MatcherUtils.ExactIgnoresCase
- ExactIgnoresCaseMatcher<TOption> - Class in com.github.rvesse.airline.prompts.matchers
- ExactIgnoresCaseMatcher() - Constructor for class com.github.rvesse.airline.prompts.matchers.ExactIgnoresCaseMatcher
- ExactLength - Annotation Type in com.github.rvesse.airline.annotations.restrictions
-
Annotation that marks that an options value is restricted to being an exact length
- ExactMatcher<TOption> - Class in com.github.rvesse.airline.prompts.matchers
- ExactMatcher() - Constructor for class com.github.rvesse.airline.prompts.matchers.ExactMatcher
- ExactOrStartsWith(String) - Constructor for class com.github.rvesse.airline.prompts.matchers.MatcherUtils.ExactOrStartsWith
- ExactOrStartsWithIgnoresCase(String) - Constructor for class com.github.rvesse.airline.prompts.matchers.MatcherUtils.ExactOrStartsWithIgnoresCase
- ExampleExecutor - Class in com.github.rvesse.airline.examples
-
Helper class that launches and runs the actual example commands and CLIs
- ExampleExecutor() - Constructor for class com.github.rvesse.airline.examples.ExampleExecutor
- ExampleRunnable - Interface in com.github.rvesse.airline.examples
- examples() - Method in annotation type com.github.rvesse.airline.annotations.help.Examples
-
An array of lines of text to provide a series of example usages of the command.
- Examples - Annotation Type in com.github.rvesse.airline.annotations.help
-
Annotation that provides an examples section for a commands help
- EXAMPLES - com.github.rvesse.airline.help.sections.HelpFormat
-
Help format is examples, the first content block is the examples and the subsequent content block(s) are explanations for the examples
- exampleSource() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalExamples
-
Source containing the examples
- ExamplesSection - Class in com.github.rvesse.airline.help.sections.common
- ExamplesSection(String[], String[]) - Constructor for class com.github.rvesse.airline.help.sections.common.ExamplesSection
- executable - Variable in class com.github.rvesse.airline.restrictions.common.PathRestriction
- executable() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.Directory
-
Gets/Sets whether the given directory must be executable
- executable() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.File
-
Gets/Sets whether the given file must be executable
- executable() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.Path
-
Gets/Sets whether the given file must be executable
- execute() - Method in class com.github.rvesse.airline.examples.help.CustomHelp
- execute() - Method in interface com.github.rvesse.airline.examples.help.YourInterface
- execute(T) - Static method in class com.github.rvesse.airline.examples.ExampleExecutor
- executeCli(Cli<T>, String[]) - Static method in class com.github.rvesse.airline.examples.ExampleExecutor
- executeSingleCommand(Class<T>, ParserMetadata<T>, String[]) - Static method in class com.github.rvesse.airline.examples.ExampleExecutor
- executeSingleCommand(Class<T>, String[]) - Static method in class com.github.rvesse.airline.examples.ExampleExecutor
- executor - Variable in class com.github.rvesse.airline.prompts.Prompt
- exitCodeComparator - Variable in class com.github.rvesse.airline.help.common.AbstractCommandUsageGenerator
- ExitCodes - Annotation Type in com.github.rvesse.airline.annotations.help
-
Annotation that indicates the exit codes section for a commands help
- ExitCodesSection - Class in com.github.rvesse.airline.help.sections.common
- ExitCodesSection(int[], String[]) - Constructor for class com.github.rvesse.airline.help.sections.common.ExitCodesSection
- ExtendedTypeConverter - Class in com.github.rvesse.airline.examples.userguide.practise
-
An example of an extended type converter that adds support for converting from types that provide an
parse(String)
method - ExtendedTypeConverter() - Constructor for class com.github.rvesse.airline.examples.userguide.practise.ExtendedTypeConverter
- externalCommands() - Method in annotation type com.github.rvesse.airline.annotations.help.SeeAlso
-
An array listing one or more external commands, i.e.
- ExternalDiscussion - Annotation Type in com.github.rvesse.airline.annotations.help.external
-
Defines a discussion section where the discussion content is provided in a text file on the classpath
- ExternalExamples - Annotation Type in com.github.rvesse.airline.annotations.help.external
-
Annotation that provides an examples section for a commands help via two external resources in textual format
- ExternalExitCodes - Annotation Type in com.github.rvesse.airline.annotations.help.external
-
Annotation that indicates the exit codes section for a commands help
- ExternalHelp - Class in com.github.rvesse.airline.examples.userguide.help.sections
- ExternalHelp() - Constructor for class com.github.rvesse.airline.examples.userguide.help.sections.ExternalHelp
- ExternalHelpFactory - Class in com.github.rvesse.airline.help.external.factories
-
Help section factory that enables the additional annotations provided by this module
- ExternalHelpFactory() - Constructor for class com.github.rvesse.airline.help.external.factories.ExternalHelpFactory
- ExternalProse - Annotation Type in com.github.rvesse.airline.annotations.help.external
-
Defines a prose section where the prose content is provided in a text file on the classpath
- ExternalTabularExamples - Annotation Type in com.github.rvesse.airline.annotations.help.external
-
Annotation that provides an examples section for a commands help via a single external resource in tabular format
F
- FACTORIES - Static variable in class com.github.rvesse.airline.help.sections.factories.HelpSectionRegistry
- FACTORY - Static variable in class com.github.rvesse.airline.Channels
- FailAll - Class in com.github.rvesse.airline.parser.errors.handlers
-
An error handler which collects all errors during parsing and then fails at the end of parsing
- FailAll() - Constructor for class com.github.rvesse.airline.parser.errors.handlers.FailAll
- FailFast - Class in com.github.rvesse.airline.parser.errors.handlers
-
An error handler which fails as soon as a parser error is encountered
- FailFast() - Constructor for class com.github.rvesse.airline.parser.errors.handlers.FailFast
- FAILURE - Static variable in class com.github.rvesse.airline.types.ConvertResult
-
Special constant instance used to indicate failure
- FAINT - com.github.rvesse.airline.io.decorations.BasicDecoration
- FAINT - Static variable in class com.github.rvesse.airline.io.AnsiControlCodes
- File - Annotation Type in com.github.rvesse.airline.annotations.restrictions
-
Annotation that marks that an options value must be a valid path to a file
- FILE - com.github.rvesse.airline.annotations.restrictions.PathKind
-
File
- FILE_FORMATS - Static variable in class com.github.rvesse.airline.help.man.ManSections
-
File formats
- FILE_URI_PREFIX - Static variable in class com.github.rvesse.airline.parser.resources.FileLocator
- FileInfo - Class in com.github.rvesse.airline.examples.userguide.help.bash
- FileInfo() - Constructor for class com.github.rvesse.airline.examples.userguide.help.bash.FileInfo
- FileLocator - Class in com.github.rvesse.airline.parser.resources
-
A resource locator that does no resolution other than removing any leading
file://
prefix i.e. - FileLocator() - Constructor for class com.github.rvesse.airline.parser.resources.FileLocator
- filename - Variable in class com.github.rvesse.airline.builder.UserAliasSourceBuilder
- filename - Variable in class com.github.rvesse.airline.parser.aliases.UserAliasesSource
- FILENAMES - com.github.rvesse.airline.help.cli.bash.CompletionBehaviour
-
Filenames, use standard filename completion if no other completions apply
- files - Variable in class com.github.rvesse.airline.examples.userguide.help.bash.FileInfo
- fillColumn(String[], int, String) - Method in class com.github.rvesse.airline.help.sections.common.VersionSection.VersionInfo
- filterResources(ScanResult) - Method in class com.github.rvesse.airline.jpms.debug.Debug
- finalValidate(ParseState<T>, ArgumentsMetadata) - Method in class com.github.rvesse.airline.restrictions.AbstractCommonRestriction
- finalValidate(ParseState<T>, ArgumentsMetadata) - Method in interface com.github.rvesse.airline.restrictions.ArgumentsRestriction
-
Method that is called after Airline has completed parsing
- finalValidate(ParseState<T>, ArgumentsMetadata) - Method in class com.github.rvesse.airline.restrictions.common.IsRequiredRestriction
- finalValidate(ParseState<T>, ArgumentsMetadata) - Method in class com.github.rvesse.airline.restrictions.common.OccurrencesRestriction
- finalValidate(ParseState<T>, ArgumentsMetadata) - Method in class com.github.rvesse.airline.restrictions.options.AbstractRequiredUnlessRestriction
- finalValidate(ParseState<T>, OptionMetadata) - Method in class com.github.rvesse.airline.restrictions.AbstractCommonRestriction
- finalValidate(ParseState<T>, OptionMetadata) - Method in class com.github.rvesse.airline.restrictions.common.IsRequiredRestriction
- finalValidate(ParseState<T>, OptionMetadata) - Method in class com.github.rvesse.airline.restrictions.common.OccurrencesRestriction
- finalValidate(ParseState<T>, OptionMetadata) - Method in interface com.github.rvesse.airline.restrictions.OptionRestriction
-
Method that is called after Airline has completed parsing
- finalValidate(ParseState<T>, OptionMetadata) - Method in class com.github.rvesse.airline.restrictions.options.AbstractRequiredUnlessRestriction
- finalValidate(ParseState<T>, OptionMetadata) - Method in class com.github.rvesse.airline.restrictions.options.MutuallyExclusiveRestriction
- finalValidate(ParseState<T>, OptionMetadata) - Method in class com.github.rvesse.airline.restrictions.options.RequiredOnlyIfRestriction
- finalValidate(ParseState<T>, OptionMetadata) - Method in class com.github.rvesse.airline.restrictions.options.RequireFromRestriction
- find(Iterable<T>, Predicate<T>, T) - Static method in class com.github.rvesse.airline.utils.AirlineUtils
- findHelpSections(CommandMetadata, List<HelpSection>, List<HelpSection>) - Method in class com.github.rvesse.airline.help.common.AbstractCommandUsageGenerator
-
Finds the help sections
- findHelpSections(GlobalMetadata<T>, List<HelpSection>, List<HelpSection>) - Method in class com.github.rvesse.airline.help.common.AbstractGlobalUsageGenerator
-
Finds the help sections
- findOption(ParseState<T>, List<OptionMetadata>, String) - Method in class com.github.rvesse.airline.parser.options.AbstractOptionParser
-
Tries to find an option with the given name
- findOption(ParseState<T>, List<OptionMetadata>, String, OptionMetadata) - Method in class com.github.rvesse.airline.parser.options.AbstractOptionParser
-
Tries to find an option with the given name
- finish() - Method in class com.github.rvesse.airline.io.printers.TroffPrinter
- finished(ParseState<T>) - Method in class com.github.rvesse.airline.parser.errors.handlers.CollectAll
- finished(ParseState<T>) - Method in class com.github.rvesse.airline.parser.errors.handlers.FailAll
- finished(ParseState<T>) - Method in class com.github.rvesse.airline.parser.errors.handlers.FailFast
- finished(ParseState<T>) - Method in interface com.github.rvesse.airline.parser.errors.handlers.ParserErrorHandler
-
Prepares the parser result
- first(Iterable<T>) - Static method in class com.github.rvesse.airline.utils.AirlineUtils
- first(Iterable<T>, T) - Static method in class com.github.rvesse.airline.utils.AirlineUtils
- first(Iterator<T>) - Static method in class com.github.rvesse.airline.utils.AirlineUtils
- first(Iterator<T>, T) - Static method in class com.github.rvesse.airline.utils.AirlineUtils
- FirstClass - com.github.rvesse.airline.examples.sendit.PostalService
- flag - Variable in class com.github.rvesse.airline.examples.simple.Simple
- flag - Variable in class com.github.rvesse.airline.examples.userguide.GettingStarted
- flagNegationPrefix - Variable in class com.github.rvesse.airline.builder.ParserBuilder
- flagNegationPrefix - Variable in class com.github.rvesse.airline.model.ParserMetadata
- flagNegationPrefix() - Method in annotation type com.github.rvesse.airline.annotations.Parser
-
Sets the flag negation prefix
- flags() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.Pattern
-
The flags for the regular expression
- FLOAT_COMPARATOR - Static variable in class com.github.rvesse.airline.restrictions.factories.RangeRestrictionFactory
- FloatComparator - Class in com.github.rvesse.airline.utils.comparators
- FloatComparator() - Constructor for class com.github.rvesse.airline.utils.comparators.FloatComparator
- FloatRange - Annotation Type in com.github.rvesse.airline.annotations.restrictions.ranges
-
Annotation that marks values as being restricted to a given float range
- floatRestrictor - Variable in class com.github.rvesse.airline.restrictions.common.PositiveNegativeRestriction
- flush() - Method in class com.github.rvesse.airline.io.printers.TroffPrinter
- flush() - Method in class com.github.rvesse.airline.io.printers.UsagePrinter
- forceBuiltInPrefix - Variable in class com.github.rvesse.airline.builder.ParserBuilder
- forceBuiltInPrefix - Variable in class com.github.rvesse.airline.model.ParserMetadata
- foreground - Variable in class com.github.rvesse.airline.io.colors.sources.AnsiColorSource
- FOREGROUND - Static variable in class com.github.rvesse.airline.io.AnsiControlCodes
-
Control Code for setting the foreground colour
- FOREGROUND_BRIGHT - Static variable in class com.github.rvesse.airline.io.AnsiControlCodes
-
Control Code for setting the high intensity variant of the foreground colour
- FOREGROUND_EXTENDED - Static variable in class com.github.rvesse.airline.io.AnsiControlCodes
-
Control Code for setting the foreground colour to an extended colour
- foregroundControl - Variable in class com.github.rvesse.airline.io.output.ColorizedOutputStream
- foregroundControl - Variable in class com.github.rvesse.airline.io.writers.ColorizedWriter
- format - Variable in class com.github.rvesse.airline.examples.cli.aliases.Logs
- format - Variable in class com.github.rvesse.airline.help.sections.common.BasicHint
- Format() - Constructor for enum com.github.rvesse.airline.examples.cli.aliases.Logs.Format
- formatBuilder - Variable in class com.github.rvesse.airline.prompts.builders.PromptBuilder
- formatter - Variable in class com.github.rvesse.airline.prompts.builders.PromptBuilder
- formatter - Variable in class com.github.rvesse.airline.prompts.Prompt
G
- g - Variable in class com.github.rvesse.airline.io.colors.TrueColor
- GAMES_AND_SCREENSAVERS - Static variable in class com.github.rvesse.airline.help.man.ManSections
-
Games and Screensavers
- GENERAL_COMMANDS - Static variable in class com.github.rvesse.airline.help.man.ManSections
-
General Commands
- generateCommandCompletionFunction(Writer, GlobalMetadata<T>, CommandGroupMetadata, CommandMetadata) - Method in class com.github.rvesse.airline.help.cli.bash.BashCompletionGenerator
- generateCommandFunctions(GlobalMetadata<T>, Writer) - Method in class com.github.rvesse.airline.help.cli.bash.BashCompletionGenerator
- generateGroupCompletionFunction(Writer, GlobalMetadata<T>, CommandGroupMetadata) - Method in class com.github.rvesse.airline.help.cli.bash.BashCompletionGenerator
- generateGroupFunctions(GlobalMetadata<T>, Writer) - Method in class com.github.rvesse.airline.help.cli.bash.BashCompletionGenerator
- generateHelp() - Static method in class com.github.rvesse.airline.examples.cli.GroupCli
- GenerateHelp - Class in com.github.rvesse.airline.examples.sendit
- GenerateHelp() - Constructor for class com.github.rvesse.airline.examples.sendit.GenerateHelp
- generateSuggestions() - Method in class com.github.rvesse.airline.help.suggester.SuggestCommand
- getAccessors() - Method in class com.github.rvesse.airline.model.ArgumentsMetadata
- getAccessors() - Method in class com.github.rvesse.airline.model.OptionMetadata
- getAlias(String) - Method in class com.github.rvesse.airline.builder.ParserBuilder
-
Retrieves an alias builder for the given alias
- getAliasChain() - Method in exception com.github.rvesse.airline.parser.errors.ParseAliasCircularReferenceException
-
Gets the chain of alias resolutions that led to the circular reference
- getAliases() - Method in class com.github.rvesse.airline.model.ParserMetadata
-
Gets the defined command aliases
- getAliasForceBuiltInPrefix() - Method in class com.github.rvesse.airline.model.ParserMetadata
-
Gets the prefix character used in alias definitions to indicate that when resolving an alias that it should force the built-in to be called even if there is an alias of that name and built-in overriding is enabled
- getAllOptions() - Method in class com.github.rvesse.airline.model.CommandMetadata
- getAllowedValues() - Method in exception com.github.rvesse.airline.parser.errors.ParseArgumentsIllegalValueException
-
Gets the set of allowed values
- getAllowedValues() - Method in exception com.github.rvesse.airline.parser.errors.ParseOptionIllegalValueException
-
Gets the set of allowed values
- getAllowedValues() - Method in class com.github.rvesse.airline.restrictions.common.AbstractAllowedValuesRestriction
- getAnnotation(Class<T>) - Method in class com.github.rvesse.airline.Accessor
- getAnnotationClasses() - Static method in class com.github.rvesse.airline.help.sections.factories.HelpSectionRegistry
-
Gets all the supported annotation classes that can be translated into help sections
- getAnsiBackgroundControlCode() - Method in interface com.github.rvesse.airline.io.colors.AnsiColorProvider
-
Gets the ANSI control code for setting the background colour
- getAnsiBackgroundControlCode() - Method in enum com.github.rvesse.airline.io.colors.BasicColor
- getAnsiBackgroundControlCode() - Method in class com.github.rvesse.airline.io.colors.Color256
- getAnsiBackgroundControlCode() - Method in class com.github.rvesse.airline.io.colors.TrueColor
- getAnsiColorCode(int) - Method in class com.github.rvesse.airline.io.colors.Color256
- getAnsiColorCode(int) - Method in class com.github.rvesse.airline.io.colors.TrueColor
- getAnsiControlCode(int) - Method in enum com.github.rvesse.airline.io.colors.BasicColor
- getAnsiControlCode(int) - Method in enum com.github.rvesse.airline.io.decorations.BasicDecoration
- getAnsiDecorationDisabledControlCode() - Method in interface com.github.rvesse.airline.io.decorations.AnsiDecorationProvider
-
Gets the ANSI control code for disabling a decoration
- getAnsiDecorationDisabledControlCode() - Method in enum com.github.rvesse.airline.io.decorations.BasicDecoration
- getAnsiDecorationEnabledControlCode() - Method in interface com.github.rvesse.airline.io.decorations.AnsiDecorationProvider
-
Gets the ANSI control code for enabling a decoration
- getAnsiDecorationEnabledControlCode() - Method in enum com.github.rvesse.airline.io.decorations.BasicDecoration
- getAnsiForegroundControlCode() - Method in interface com.github.rvesse.airline.io.colors.AnsiColorProvider
-
Gets the ANSI control code for setting the foreground colour
- getAnsiForegroundControlCode() - Method in enum com.github.rvesse.airline.io.colors.BasicColor
- getAnsiForegroundControlCode() - Method in class com.github.rvesse.airline.io.colors.Color256
- getAnsiForegroundControlCode() - Method in class com.github.rvesse.airline.io.colors.TrueColor
- getArguments() - Method in class com.github.rvesse.airline.model.AliasMetadata
-
Gets the arguments that the alias expands to
- getArguments() - Method in class com.github.rvesse.airline.model.CommandMetadata
- getArgumentsRestriction(Class<? extends Annotation>, T) - Static method in class com.github.rvesse.airline.restrictions.factories.RestrictionRegistry
- getArgumentsRestrictionAnnotationClasses() - Static method in class com.github.rvesse.airline.restrictions.factories.RestrictionRegistry
- getArgumentsSeparator() - Method in class com.github.rvesse.airline.model.ParserMetadata
-
Gets the arguments separator to be used
- getArgumentTitle() - Method in exception com.github.rvesse.airline.parser.errors.ParseArgumentsMissingException
-
Gets the argument title
- getArgumentTitle(ArgumentsMetadata, int) - Static method in class com.github.rvesse.airline.restrictions.AbstractCommonRestriction
- getArgumentTitle(ParseState<T>, ArgumentsMetadata) - Static method in class com.github.rvesse.airline.restrictions.AbstractCommonRestriction
- getArity() - Method in class com.github.rvesse.airline.model.OptionMetadata
- getBaseHelpSections() - Method in class com.github.rvesse.airline.model.GlobalMetadata
-
Gets the base help sections used by all commands unless specifically overridden by individual commands
- getBigDecimal(NumericCandidate) - Method in class com.github.rvesse.airline.types.numerics.ComplexNumericTypeConverter
- getBigInteger(NumericCandidate) - Method in class com.github.rvesse.airline.types.numerics.ComplexNumericTypeConverter
- getBytes(String) - Method in class com.github.rvesse.airline.io.output.OutputStreamControlTracker
- getCause() - Method in class com.github.rvesse.airline.types.ConvertResult
-
Gets the cause if available
- getCollection() - Method in class com.github.rvesse.airline.parser.errors.handlers.AbstractCollectingHandler
- getColor(int) - Method in class com.github.rvesse.airline.examples.io.Colors256
- getColor(int) - Method in class com.github.rvesse.airline.examples.io.ColorsTrue
- getColors() - Method in class com.github.rvesse.airline.examples.io.ColorDemo
- getColors() - Method in class com.github.rvesse.airline.examples.io.Colors256
- getColors() - Method in class com.github.rvesse.airline.examples.io.ColorsBasic
- getColors() - Method in class com.github.rvesse.airline.examples.io.ColorsTrue
- getCommand() - Method in class com.github.rvesse.airline.parser.ParseResult
-
Gets the command if one was successfully parsed
- getCommand() - Method in class com.github.rvesse.airline.parser.ParseState
- getCommandComparator() - Method in class com.github.rvesse.airline.help.common.AbstractUsageGenerator
- getCommandFactory() - Method in class com.github.rvesse.airline.model.ParserMetadata
-
Gets the command factory to use
- getCommandGroups() - Method in class com.github.rvesse.airline.model.GlobalMetadata
-
Gets the command groups for the CLI
- getCommandMetadata() - Method in class com.github.rvesse.airline.SingleCommand
-
Gets the command metadata
- getCommandName(GlobalMetadata<T>, String[], CommandMetadata) - Method in class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator
-
Gets the display name for a command
- getCommandName(GlobalMetadata<T>, String[], CommandMetadata) - Method in class com.github.rvesse.airline.help.markdown.MarkdownMultiPageGlobalUsageGenerator
- getCommandOptions() - Method in class com.github.rvesse.airline.model.CommandMetadata
- getCommands() - Method in class com.github.rvesse.airline.model.CommandGroupMetadata
-
Gets the commands for the group
- getCompletionData(ArgumentsMetadata) - Method in class com.github.rvesse.airline.help.cli.bash.BashCompletionGenerator
-
Gets the completion info for arguments
- getCompletionData(OptionMetadata) - Method in class com.github.rvesse.airline.help.cli.bash.BashCompletionGenerator
-
Gets the completion info for an option
- getCompletionData(Collection<Accessor>) - Method in class com.github.rvesse.airline.help.cli.bash.BashCompletionGenerator
- getCompositionAnnotations() - Method in class com.github.rvesse.airline.model.ParserMetadata
-
Gets the set of annotation class names to follow when building the metadata for commands i.e.
- getContentBlock(int) - Method in class com.github.rvesse.airline.examples.userguide.restrictions.custom.MultipleOfRestriction
- getContentBlock(int) - Method in class com.github.rvesse.airline.help.sections.common.BasicHint
- getContentBlock(int) - Method in class com.github.rvesse.airline.help.sections.common.VersionSection
- getContentBlock(int) - Method in interface com.github.rvesse.airline.help.sections.HelpHint
-
Gets the content block with the given number
- getContentBlock(int) - Method in class com.github.rvesse.airline.restrictions.common.AbstractAllowedValuesRestriction
- getContentBlock(int) - Method in class com.github.rvesse.airline.restrictions.common.EndsWithRestriction
- getContentBlock(int) - Method in class com.github.rvesse.airline.restrictions.common.LengthRestriction
- getContentBlock(int) - Method in class com.github.rvesse.airline.restrictions.common.NoOptionLikeValuesRestriction
- getContentBlock(int) - Method in class com.github.rvesse.airline.restrictions.common.NotBlankRestriction
- getContentBlock(int) - Method in class com.github.rvesse.airline.restrictions.common.NotEmptyRestriction
- getContentBlock(int) - Method in class com.github.rvesse.airline.restrictions.common.OccurrencesRestriction
- getContentBlock(int) - Method in class com.github.rvesse.airline.restrictions.common.PartialRestriction
- getContentBlock(int) - Method in class com.github.rvesse.airline.restrictions.common.PathRestriction
- getContentBlock(int) - Method in class com.github.rvesse.airline.restrictions.common.PatternRestriction
- getContentBlock(int) - Method in class com.github.rvesse.airline.restrictions.common.PortRestriction
- getContentBlock(int) - Method in class com.github.rvesse.airline.restrictions.common.PositiveNegativeRestriction
- getContentBlock(int) - Method in class com.github.rvesse.airline.restrictions.common.RangeRestriction
- getContentBlock(int) - Method in class com.github.rvesse.airline.restrictions.common.StartsWithRestriction
- getContentBlock(int) - Method in class com.github.rvesse.airline.restrictions.options.MutuallyExclusiveRestriction
- getContentBlock(int) - Method in class com.github.rvesse.airline.restrictions.options.RequiredOnlyIfRestriction
- getContentBlock(int) - Method in class com.github.rvesse.airline.restrictions.options.RequiredUnlessEnvironmentRestriction
- getContentBlock(int) - Method in class com.github.rvesse.airline.restrictions.options.RequireFromRestriction
- getControlCode(T) - Method in class com.github.rvesse.airline.io.colors.sources.AnsiColorSource
- getControlCode(T) - Method in interface com.github.rvesse.airline.io.ControlCodeSource
-
Translates the attribute source into a control code that can be passed to an input/output stream
- getControlCode(T) - Method in class com.github.rvesse.airline.io.decorations.sources.AnsiDecorationSource
- getConvertedValue() - Method in class com.github.rvesse.airline.types.ConvertResult
-
The converted value
- getCurrentOption() - Method in class com.github.rvesse.airline.parser.ParseState
- getDefaultCommand() - Method in class com.github.rvesse.airline.model.CommandGroupMetadata
-
Gets the default command for the group
- getDefaultCommand() - Method in class com.github.rvesse.airline.model.GlobalMetadata
-
Gets the default command for the CLI
- getDefaultGroupCommands() - Method in class com.github.rvesse.airline.model.GlobalMetadata
-
Gets the default group of commands for the CLI i.e.
- getDefaultOption() - Method in class com.github.rvesse.airline.model.CommandMetadata
- getDescription() - Method in class com.github.rvesse.airline.model.ArgumentsMetadata
- getDescription() - Method in class com.github.rvesse.airline.model.CommandGroupMetadata
-
Gets the description for the group
- getDescription() - Method in class com.github.rvesse.airline.model.CommandMetadata
- getDescription() - Method in class com.github.rvesse.airline.model.GlobalMetadata
-
Gets the description of the CLI
- getDescription() - Method in class com.github.rvesse.airline.model.OptionMetadata
- getDouble(NumericCandidate) - Method in class com.github.rvesse.airline.types.numerics.ComplexNumericTypeConverter
- getErrorHandler() - Method in class com.github.rvesse.airline.model.ParserMetadata
-
Gets the error handler to use
- getErrors() - Method in class com.github.rvesse.airline.parser.ParseResult
-
Gets the collection of errors that occurred, may be empty if parsing was successful
- getExactMatcher(String) - Method in class com.github.rvesse.airline.prompts.matchers.DefaultMatcher
-
Gets an exact matcher
- getExactMatcher(String) - Method in class com.github.rvesse.airline.prompts.matchers.IgnoresCaseMatcher
- getExactOrPartialMatcher(String) - Method in class com.github.rvesse.airline.prompts.matchers.DefaultMatcher
-
Gets an exact or partial matcher
- getExactOrPartialMatcher(String) - Method in class com.github.rvesse.airline.prompts.matchers.ExactIgnoresCaseMatcher
- getExactOrPartialMatcher(String) - Method in class com.github.rvesse.airline.prompts.matchers.ExactMatcher
- getExactOrPartialMatcher(String) - Method in class com.github.rvesse.airline.prompts.matchers.IgnoresCaseMatcher
- getFilename() - Method in class com.github.rvesse.airline.parser.aliases.UserAliasesSource
-
Gets the filename of the configuration file that will be scanned for alias definitions
- getFlagNegationPrefix() - Method in class com.github.rvesse.airline.model.ParserMetadata
-
Gets the flag negation prefix that is in use (if any)
- getFloat(NumericCandidate) - Method in class com.github.rvesse.airline.types.numerics.ComplexNumericTypeConverter
- getFormat() - Method in class com.github.rvesse.airline.examples.userguide.restrictions.custom.MultipleOfRestriction
- getFormat() - Method in class com.github.rvesse.airline.help.sections.common.BasicHint
- getFormat() - Method in class com.github.rvesse.airline.help.sections.common.VersionSection
- getFormat() - Method in interface com.github.rvesse.airline.help.sections.HelpHint
-
Gets the format of the provided help information
- getFormat() - Method in class com.github.rvesse.airline.restrictions.common.AbstractAllowedValuesRestriction
- getFormat() - Method in class com.github.rvesse.airline.restrictions.common.EndsWithRestriction
- getFormat() - Method in class com.github.rvesse.airline.restrictions.common.LengthRestriction
- getFormat() - Method in class com.github.rvesse.airline.restrictions.common.NoOptionLikeValuesRestriction
- getFormat() - Method in class com.github.rvesse.airline.restrictions.common.NotBlankRestriction
- getFormat() - Method in class com.github.rvesse.airline.restrictions.common.NotEmptyRestriction
- getFormat() - Method in class com.github.rvesse.airline.restrictions.common.OccurrencesRestriction
- getFormat() - Method in class com.github.rvesse.airline.restrictions.common.PartialRestriction
- getFormat() - Method in class com.github.rvesse.airline.restrictions.common.PathRestriction
- getFormat() - Method in class com.github.rvesse.airline.restrictions.common.PatternRestriction
- getFormat() - Method in class com.github.rvesse.airline.restrictions.common.PortRestriction
- getFormat() - Method in class com.github.rvesse.airline.restrictions.common.PositiveNegativeRestriction
- getFormat() - Method in class com.github.rvesse.airline.restrictions.common.RangeRestriction
- getFormat() - Method in class com.github.rvesse.airline.restrictions.common.StartsWithRestriction
- getFormat() - Method in class com.github.rvesse.airline.restrictions.options.MutuallyExclusiveRestriction
- getFormat() - Method in class com.github.rvesse.airline.restrictions.options.RequiredOnlyIfRestriction
- getFormat() - Method in class com.github.rvesse.airline.restrictions.options.RequiredUnlessEnvironmentRestriction
- getFormat() - Method in class com.github.rvesse.airline.restrictions.options.RequireFromRestriction
- getFullCommandName(String, String[], String) - Method in class com.github.rvesse.airline.help.man.ManCommandUsageGenerator
-
Gets the full command name in man page syntax
- getFullResetControlCode() - Method in class com.github.rvesse.airline.io.colors.sources.AnsiColorSource
- getFullResetControlCode() - Method in interface com.github.rvesse.airline.io.ControlCodeSource
-
Gets a reset code that can be used to reset any changes previously made by any attributes of the type supported by this source
- getFullResetControlCode() - Method in class com.github.rvesse.airline.io.decorations.sources.AnsiDecorationSource
- getGlobal() - Method in class com.github.rvesse.airline.parser.ParseState
- getGlobalOptions() - Method in class com.github.rvesse.airline.model.CommandMetadata
- getGlobalRestriction(Class<? extends Annotation>, T) - Static method in class com.github.rvesse.airline.restrictions.factories.RestrictionRegistry
- getGlobalRestrictionAnnotationClasses() - Static method in class com.github.rvesse.airline.restrictions.factories.RestrictionRegistry
- getGraphicsResetCode() - Static method in class com.github.rvesse.airline.io.AnsiControlCodes
-
Provides the ANSI full graphics reset code
- getGroup() - Method in class com.github.rvesse.airline.parser.ParseState
- getGroup(String) - Method in class com.github.rvesse.airline.builder.CliBuilder
- getGroupNames() - Method in class com.github.rvesse.airline.model.CommandMetadata
- getGroupOptions() - Method in class com.github.rvesse.airline.model.CommandMetadata
- getGroups() - Method in class com.github.rvesse.airline.model.CommandMetadata
- getHelpSection(Class<? extends Annotation>, Annotation) - Static method in class com.github.rvesse.airline.help.sections.factories.HelpSectionRegistry
-
Given an annotation returns a help section if the annotation can be translated into one by any of the registered factories
- getHelpSections() - Method in class com.github.rvesse.airline.model.CommandMetadata
-
Gets the additional help sections
- getIllegalValue() - Method in exception com.github.rvesse.airline.parser.errors.ParseArgumentsIllegalValueException
-
Gets the illegal value
- getIllegalValue() - Method in exception com.github.rvesse.airline.parser.errors.ParseOptionIllegalValueException
-
Gets the illegal value
- getIllegalValue() - Method in exception com.github.rvesse.airline.parser.errors.ParseOptionOutOfRangeException
- getItemType(String, Type) - Static method in class com.github.rvesse.airline.Accessor
- getJavaType() - Method in class com.github.rvesse.airline.Accessor
- getJavaType() - Method in class com.github.rvesse.airline.model.ArgumentsMetadata
- getJavaType() - Method in class com.github.rvesse.airline.model.OptionMetadata
- getLocation() - Method in class com.github.rvesse.airline.parser.ParseState
- getLocators() - Method in class com.github.rvesse.airline.parser.aliases.UserAliasesSource
-
Gets the locators that are used to resolve search locations to actual usable locations
- getLong(NumericCandidate) - Method in class com.github.rvesse.airline.types.numerics.ComplexNumericTypeConverter
- getMaximumPort() - Method in enum com.github.rvesse.airline.annotations.restrictions.PortType
- getMaximumPort() - Method in interface com.github.rvesse.airline.restrictions.common.PortRange
-
Gets the maximum port
- getMaximumPort() - Method in class com.github.rvesse.airline.restrictions.common.PortRangeImpl
- getMaximumValue() - Method in exception com.github.rvesse.airline.parser.errors.ParseOptionOutOfRangeException
- getMessage() - Method in class com.github.rvesse.airline.prompts.Prompt
-
Gets the prompt message
- getMetadata() - Method in class com.github.rvesse.airline.Cli
-
Gets the global meta-data
- getMetadataInjections() - Method in class com.github.rvesse.airline.model.CommandMetadata
- getMetadataInjections() - Method in class com.github.rvesse.airline.model.SuggesterMetadata
- getMinimumPort() - Method in enum com.github.rvesse.airline.annotations.restrictions.PortType
- getMinimumPort() - Method in interface com.github.rvesse.airline.restrictions.common.PortRange
-
Gets the minimum port
- getMinimumPort() - Method in class com.github.rvesse.airline.restrictions.common.PortRangeImpl
- getMinimumValue() - Method in exception com.github.rvesse.airline.parser.errors.ParseOptionOutOfRangeException
- getMultiplier(NumericCandidate) - Method in class com.github.rvesse.airline.types.numerics.abbreviated.AbbreviatedNumericTypeConverter
- getMultiplier(NumericCandidate) - Method in class com.github.rvesse.airline.types.numerics.ComplexNumericTypeConverter
- getMultiplier(String) - Method in class com.github.rvesse.airline.types.numerics.abbreviated.AbbreviatedNumericTypeConverter
- getMultiplier(String) - Method in class com.github.rvesse.airline.types.numerics.abbreviated.MapAbbreviatedNumericTypeConverter
- getName() - Method in class com.github.rvesse.airline.Accessor
- getName() - Method in class com.github.rvesse.airline.model.AliasMetadata
-
Gets the alias name
- getName() - Method in class com.github.rvesse.airline.model.CommandGroupMetadata
-
Gets the name of the group
- getName() - Method in class com.github.rvesse.airline.model.CommandMetadata
- getName() - Method in class com.github.rvesse.airline.model.GlobalMetadata
-
Gets the name of the CLI
- getOffendingAlias() - Method in exception com.github.rvesse.airline.parser.errors.ParseAliasCircularReferenceException
-
Gets the alias that was encountered that is a circular reference
- getOptionComparator() - Method in class com.github.rvesse.airline.help.common.AbstractUsageGenerator
- getOptionMatcher() - Method in class com.github.rvesse.airline.prompts.Prompt
- getOptionName() - Method in exception com.github.rvesse.airline.parser.errors.ParseOptionIllegalValueException
-
Gets the option name i.e.
- getOptionParsers() - Method in class com.github.rvesse.airline.model.ParserMetadata
-
Gets the option parsers to use
- getOptionRestriction(Class<? extends Annotation>, T) - Static method in class com.github.rvesse.airline.restrictions.factories.RestrictionRegistry
- getOptionRestrictionAnnotationClasses() - Static method in class com.github.rvesse.airline.restrictions.factories.RestrictionRegistry
- getOptions() - Method in class com.github.rvesse.airline.model.CommandGroupMetadata
-
Gets the group options
- getOptions() - Method in class com.github.rvesse.airline.model.GlobalMetadata
-
Gets the global scoped options
- getOptions() - Method in class com.github.rvesse.airline.model.OptionMetadata
- getOptions() - Method in exception com.github.rvesse.airline.parser.errors.ParseOptionGroupException
- getOptions() - Method in class com.github.rvesse.airline.prompts.Prompt
-
Gets the available options (if any)
- getOptionTitle() - Method in exception com.github.rvesse.airline.parser.errors.ParseArgumentsIllegalValueException
-
Gets the option title
- getOptionTitle() - Method in exception com.github.rvesse.airline.parser.errors.ParseOptionConversionException
- getOptionTitle() - Method in exception com.github.rvesse.airline.parser.errors.ParseOptionIllegalValueException
-
Gets the option value title
- getOptionTitle() - Method in exception com.github.rvesse.airline.parser.errors.ParseOptionMissingException
- getOptionTitle() - Method in exception com.github.rvesse.airline.parser.errors.ParseOptionMissingValueException
- getOptionTitle(ParseState<T>, OptionMetadata) - Static method in class com.github.rvesse.airline.restrictions.AbstractCommonRestriction
- getOptionType() - Method in class com.github.rvesse.airline.model.OptionMetadata
- getOptionValuesSeen(OptionMetadata) - Method in class com.github.rvesse.airline.parser.ParseState
- getOrCreateCollectionField(String, Object, Field) - Static method in class com.github.rvesse.airline.Accessor
- getOriginalValue() - Method in class com.github.rvesse.airline.types.numerics.NumericCandidate
- getParent() - Method in class com.github.rvesse.airline.model.CommandGroupMetadata
-
Gets the parent group which may be null
- getParsedArguments() - Method in class com.github.rvesse.airline.parser.ParseState
- getParsedOptions() - Method in class com.github.rvesse.airline.parser.ParseState
- getParserConfiguration() - Method in class com.github.rvesse.airline.model.GlobalMetadata
-
Gets the parser configuration for the CLI
- getParserConfiguration() - Method in class com.github.rvesse.airline.parser.ParseState
- getParserConfiguration() - Method in class com.github.rvesse.airline.SingleCommand
-
Gets the parser configuration
- getPath() - Method in class com.github.rvesse.airline.examples.simple.Paths.PathSource
- getPermittedPrefixes() - Method in class com.github.rvesse.airline.types.numerics.abbreviated.AbbreviatedNumericTypeConverter
- getPermittedPrefixes() - Method in class com.github.rvesse.airline.types.numerics.abbreviated.MapAbbreviatedNumericTypeConverter
- getPermittedSuffixes() - Method in class com.github.rvesse.airline.types.numerics.abbreviated.AbbreviatedNumericTypeConverter
- getPermittedSuffixes() - Method in class com.github.rvesse.airline.types.numerics.abbreviated.MapAbbreviatedNumericTypeConverter
- getPostamble() - Method in class com.github.rvesse.airline.help.sections.common.BasicSection
- getPostamble() - Method in class com.github.rvesse.airline.help.sections.common.VersionSection
- getPostamble() - Method in interface com.github.rvesse.airline.help.sections.HelpSection
-
Gets the post-amble text that should be included at the end of the section
- getPreamble() - Method in class com.github.rvesse.airline.examples.userguide.restrictions.custom.MultipleOfRestriction
- getPreamble() - Method in class com.github.rvesse.airline.help.sections.common.BasicHint
- getPreamble() - Method in class com.github.rvesse.airline.help.sections.common.VersionSection
- getPreamble() - Method in interface com.github.rvesse.airline.help.sections.HelpHint
-
Gets the preamble text that should be included
- getPreamble() - Method in class com.github.rvesse.airline.restrictions.common.AbstractAllowedValuesRestriction
- getPreamble() - Method in class com.github.rvesse.airline.restrictions.common.EndsWithRestriction
- getPreamble() - Method in class com.github.rvesse.airline.restrictions.common.LengthRestriction
- getPreamble() - Method in class com.github.rvesse.airline.restrictions.common.NoOptionLikeValuesRestriction
- getPreamble() - Method in class com.github.rvesse.airline.restrictions.common.NotBlankRestriction
- getPreamble() - Method in class com.github.rvesse.airline.restrictions.common.NotEmptyRestriction
- getPreamble() - Method in class com.github.rvesse.airline.restrictions.common.OccurrencesRestriction
- getPreamble() - Method in class com.github.rvesse.airline.restrictions.common.PartialRestriction
- getPreamble() - Method in class com.github.rvesse.airline.restrictions.common.PathRestriction
- getPreamble() - Method in class com.github.rvesse.airline.restrictions.common.PatternRestriction
- getPreamble() - Method in class com.github.rvesse.airline.restrictions.common.PortRestriction
- getPreamble() - Method in class com.github.rvesse.airline.restrictions.common.PositiveNegativeRestriction
- getPreamble() - Method in class com.github.rvesse.airline.restrictions.common.RangeRestriction
- getPreamble() - Method in class com.github.rvesse.airline.restrictions.common.StartsWithRestriction
- getPreamble() - Method in class com.github.rvesse.airline.restrictions.options.MutuallyExclusiveRestriction
- getPreamble() - Method in class com.github.rvesse.airline.restrictions.options.RequiredOnlyIfRestriction
- getPreamble() - Method in class com.github.rvesse.airline.restrictions.options.RequiredUnlessEnvironmentRestriction
- getPreamble() - Method in class com.github.rvesse.airline.restrictions.options.RequireFromRestriction
- getPrefix() - Method in class com.github.rvesse.airline.parser.aliases.UserAliasesSource
-
Gets the prefix that is used to distinguish alias definitions from other property definitions in the configuration file
- getPrefix() - Method in class com.github.rvesse.airline.types.numerics.NumericCandidate
- getPromptWriter() - Method in class com.github.rvesse.airline.prompts.console.ConsolePrompt
- getPromptWriter() - Method in class com.github.rvesse.airline.prompts.console.StreamPrompt
- getPromptWriter() - Method in interface com.github.rvesse.airline.prompts.PromptProvider
-
Gets the writer to which prompts should be written
- getProvider() - Method in class com.github.rvesse.airline.prompts.Prompt
-
Gets the prompt provider
- getRadix(NumericCandidate) - Method in class com.github.rvesse.airline.types.numerics.abbreviated.AbbreviatedNumericTypeConverter
- getRadix(NumericCandidate) - Method in class com.github.rvesse.airline.types.numerics.bases.Binary
- getRadix(NumericCandidate) - Method in class com.github.rvesse.airline.types.numerics.bases.Hexadecimal
- getRadix(NumericCandidate) - Method in class com.github.rvesse.airline.types.numerics.bases.Octal
- getRadix(NumericCandidate) - Method in class com.github.rvesse.airline.types.numerics.ComplexNumericTypeConverter
- getRadix(String) - Method in class com.github.rvesse.airline.types.numerics.abbreviated.AbbreviatedNumericTypeConverter
- getRadix(String) - Method in class com.github.rvesse.airline.types.numerics.abbreviated.MapAbbreviatedNumericTypeConverter
- getRawType(Type) - Static method in class com.github.rvesse.airline.Accessor
- getResetControlCode(T) - Method in class com.github.rvesse.airline.io.colors.sources.AnsiColorSource
- getResetControlCode(T) - Method in interface com.github.rvesse.airline.io.ControlCodeSource
-
Gets a reset code that can be used to reset any changes previously made by the given attribute
- getResetControlCode(T) - Method in class com.github.rvesse.airline.io.decorations.sources.AnsiDecorationSource
- getRestrictionPredicate() - Method in class com.github.rvesse.airline.utils.predicates.restrictions.AbstractOptionRestrictionBasedFinder
- getRestrictionPredicate() - Method in class com.github.rvesse.airline.utils.predicates.restrictions.AbstractParsedOptionRestrictionBasedFinder
- getRestrictionPredicate() - Method in class com.github.rvesse.airline.utils.predicates.restrictions.MutuallyExclusiveWithOptionFinder
- getRestrictionPredicate() - Method in class com.github.rvesse.airline.utils.predicates.restrictions.MutuallyExclusiveWithTagParsedOptionFinder
- getRestrictionPredicate() - Method in class com.github.rvesse.airline.utils.predicates.restrictions.RequiredTagOptionFinder
- getRestrictionPredicate() - Method in class com.github.rvesse.airline.utils.predicates.restrictions.RequiredTagParsedOptionFinder
- getRestrictions() - Method in class com.github.rvesse.airline.model.ArgumentsMetadata
- getRestrictions() - Method in class com.github.rvesse.airline.model.GlobalMetadata
-
Gets the global restrictions
- getRestrictions() - Method in class com.github.rvesse.airline.model.OptionMetadata
- getSearchLocations() - Method in class com.github.rvesse.airline.parser.aliases.UserAliasesSource
-
Gets the search locations where the configuration file may be located in order of preference
- getSource() - Method in class com.github.rvesse.airline.examples.simple.Paths.PathSource
- getState() - Method in class com.github.rvesse.airline.parser.ParseResult
-
Gets the final parser state
- getSubGroup(String) - Method in class com.github.rvesse.airline.builder.GroupBuilder
- getSubGroups() - Method in class com.github.rvesse.airline.model.CommandGroupMetadata
-
Gets the sub-groups of this group
- getSuffix() - Method in class com.github.rvesse.airline.types.numerics.NumericCandidate
- getSuggesterClass() - Method in class com.github.rvesse.airline.model.SuggesterMetadata
- getTabularFormat() - Method in class com.github.rvesse.airline.help.external.parsers.defaults.DefaultExternalHelpParser
-
Gets the tabular format in use for parsing tabular data
- getTabularFormat() - Method in class com.github.rvesse.airline.help.external.parsers.defaults.TabDelimitedHelpParser
- getTag() - Method in exception com.github.rvesse.airline.parser.errors.ParseOptionGroupException
- getTag() - Method in class com.github.rvesse.airline.restrictions.options.MutuallyExclusiveRestriction
- getTag() - Method in class com.github.rvesse.airline.restrictions.options.RequireFromRestriction
- getTaggedOptions(ParseState<T>) - Method in class com.github.rvesse.airline.restrictions.options.MutuallyExclusiveRestriction
- getTaggedOptions(ParseState<T>) - Method in class com.github.rvesse.airline.restrictions.options.RequireFromRestriction
- getTimeout() - Method in class com.github.rvesse.airline.prompts.Prompt
-
Gets the configured timeout
- getTimeoutUnit() - Method in class com.github.rvesse.airline.prompts.Prompt
-
Gets the timeout unit
- GettingStarted - Class in com.github.rvesse.airline.examples.userguide
- GettingStarted() - Constructor for class com.github.rvesse.airline.examples.userguide.GettingStarted
- getTitle() - Method in class com.github.rvesse.airline.help.sections.common.BasicSection
- getTitle() - Method in class com.github.rvesse.airline.help.sections.common.VersionSection
- getTitle() - Method in interface com.github.rvesse.airline.help.sections.HelpSection
-
Gets the title for the section
- getTitle() - Method in class com.github.rvesse.airline.model.ArgumentsMetadata
- getTitle() - Method in class com.github.rvesse.airline.model.OptionMetadata
-
Deprecated.Options now support multiple titles, use
OptionMetadata.getTitle(int)
to get a specific title orOptionMetadata.getTitles()
to get all titles - getTitle(int) - Method in class com.github.rvesse.airline.model.OptionMetadata
- getTitles() - Method in class com.github.rvesse.airline.model.OptionMetadata
- getType() - Method in class com.github.rvesse.airline.model.CommandMetadata
-
Gets the command type i.e.
- getTypeConverter() - Method in class com.github.rvesse.airline.model.ParserMetadata
-
Gets the type converter to use
- getTypeConverter() - Method in class com.github.rvesse.airline.prompts.Prompt
-
Gets the configured type converter
- getTypeConverter(ArgumentsMetadata, ParseState<T>) - Method in class com.github.rvesse.airline.types.DefaultTypeConverterProvider
- getTypeConverter(ArgumentsMetadata, ParseState<T>) - Method in class com.github.rvesse.airline.types.numerics.DefaultNumericConverter
- getTypeConverter(ArgumentsMetadata, ParseState<T>) - Method in interface com.github.rvesse.airline.types.TypeConverterProvider
-
Gets the type converter to use for the given arguments and parser state
- getTypeConverter(OptionMetadata, ParseState<T>) - Method in class com.github.rvesse.airline.types.DefaultTypeConverterProvider
- getTypeConverter(OptionMetadata, ParseState<T>) - Method in class com.github.rvesse.airline.types.numerics.DefaultNumericConverter
- getTypeConverter(OptionMetadata, ParseState<T>) - Method in interface com.github.rvesse.airline.types.TypeConverterProvider
-
Gets the type converter to use for the given option and parser state
- getTypeConverter(ParseState<T>) - Method in class com.github.rvesse.airline.parser.AbstractParser
-
Gets the type converter to use for converting arguments into option/argument values
- getTypeConverterProvider() - Method in class com.github.rvesse.airline.model.ArgumentsMetadata
- getTypeConverterProvider() - Method in class com.github.rvesse.airline.model.OptionMetadata
- getTypeName() - Method in exception com.github.rvesse.airline.parser.errors.ParseOptionConversionException
- getTypeParameters(Class<?>, Type) - Static method in class com.github.rvesse.airline.Accessor
- getUnparsedInput() - Method in exception com.github.rvesse.airline.parser.errors.ParseArgumentsUnexpectedException
- getUnparsedInput() - Method in exception com.github.rvesse.airline.parser.errors.ParseCommandUnrecognizedException
- getUnparsedInput() - Method in class com.github.rvesse.airline.parser.ParseState
- getUserAliasesSource() - Method in class com.github.rvesse.airline.model.ParserMetadata
-
Gets the user aliases source (if any)
- getValue() - Method in exception com.github.rvesse.airline.parser.errors.ParseOptionConversionException
- getValue() - Method in class com.github.rvesse.airline.types.numerics.NumericCandidate
- getValue(Object) - Method in class com.github.rvesse.airline.Accessor
- getValues(Class<? extends Enum<?>>) - Method in class com.github.rvesse.airline.restrictions.common.AllowedEnumValuesRestriction
- getValues(String) - Method in class com.github.rvesse.airline.parser.options.ListValueOptionParser
- getValues(String) - Method in class com.github.rvesse.airline.parser.options.MaybePairValueOptionParser
- global - Variable in class com.github.rvesse.airline.examples.cli.commands.BashCompletion
- global - Variable in class com.github.rvesse.airline.examples.cli.commands.Help
- global - Variable in class com.github.rvesse.airline.examples.cli.commands.Manuals
- global - Variable in class com.github.rvesse.airline.help.Help
- global - Variable in class com.github.rvesse.airline.parser.ParseState
- GLOBAL - com.github.rvesse.airline.annotations.OptionType
- GLOBAL - com.github.rvesse.airline.Context
- GLOBAL_RESTRICTION_FACTORIES - Static variable in class com.github.rvesse.airline.restrictions.factories.RestrictionRegistry
- globalMetadata - Variable in class com.github.rvesse.airline.HelpOption
- GlobalMetadata<T> - Class in com.github.rvesse.airline.model
-
Represents metadata about a CLI
- GlobalMetadata(String, String, Iterable<OptionMetadata>, CommandMetadata, Iterable<CommandMetadata>, Iterable<CommandGroupMetadata>, Iterable<GlobalRestriction>, Iterable<HelpSection>, ParserMetadata<T>) - Constructor for class com.github.rvesse.airline.model.GlobalMetadata
- globalOptions - Variable in class com.github.rvesse.airline.model.CommandMetadata
- globalOptions - Variable in class com.github.rvesse.airline.model.MetadataLoader.InjectionMetadata
- GlobalRestriction - Interface in com.github.rvesse.airline.restrictions
-
Interface for restrictions
- GlobalRestrictionFactory - Interface in com.github.rvesse.airline.restrictions.factories
-
Interface for option restriction factories
- GlobalSuggester<T> - Class in com.github.rvesse.airline.help.suggester
- GlobalSuggester() - Constructor for class com.github.rvesse.airline.help.suggester.GlobalSuggester
- GlobalUsageGenerator<T> - Interface in com.github.rvesse.airline.help
-
Interface implemented by classes that can generate usage documentation for a command line interface
- glyph - Variable in enum com.github.rvesse.airline.io.printers.TroffPrinter.BulletStyle
- GoodGrandchild - Class in com.github.rvesse.airline.examples.inheritance
-
When inheriting from existing classes it is possible to override previously defined options but only if you are explicit about it.
- GoodGrandchild() - Constructor for class com.github.rvesse.airline.examples.inheritance.GoodGrandchild
- GreedyClassicGetOptParser<T> - Class in com.github.rvesse.airline.parser.options
-
Greedy variant of the
ClassicGetOptParser
that allows consuming values that could otherwise be treated as options in their own right. - GreedyClassicGetOptParser() - Constructor for class com.github.rvesse.airline.parser.options.GreedyClassicGetOptParser
- GreedyMaybeListValueOptionParser<T> - Class in com.github.rvesse.airline.parser.options
-
A variation on the
MaybeListValueOptionParser
that is greedy - GreedyMaybeListValueOptionParser() - Constructor for class com.github.rvesse.airline.parser.options.GreedyMaybeListValueOptionParser
- GreedyMaybeListValueOptionParser(char) - Constructor for class com.github.rvesse.airline.parser.options.GreedyMaybeListValueOptionParser
- green - Variable in class com.github.rvesse.airline.examples.io.ColorsTrue
- GREEN - com.github.rvesse.airline.io.colors.BasicColor
- group - Variable in class com.github.rvesse.airline.help.suggester.GroupSuggester
- group - Variable in class com.github.rvesse.airline.parser.ParseState
- Group - Annotation Type in com.github.rvesse.airline.annotations
-
Marks a class as providing command group metadata
- GROUP - com.github.rvesse.airline.annotations.OptionType
- GROUP - com.github.rvesse.airline.Context
- Group.NO_DEFAULT - Class in com.github.rvesse.airline.annotations
- GroupBuilder<C> - Class in com.github.rvesse.airline.builder
- GroupBuilder(CliBuilder<C>, GroupBuilder<C>, String) - Constructor for class com.github.rvesse.airline.builder.GroupBuilder
- GroupBuilder(CliBuilder<C>, String) - Constructor for class com.github.rvesse.airline.builder.GroupBuilder
- GroupCli - Class in com.github.rvesse.airline.examples.cli
-
An example of creating a CLI using command groups
- GroupCli() - Constructor for class com.github.rvesse.airline.examples.cli.GroupCli
- GroupFinder - Class in com.github.rvesse.airline.utils.predicates.parser
- GroupFinder(String) - Constructor for class com.github.rvesse.airline.utils.predicates.parser.GroupFinder
- groupMetadata - Variable in class com.github.rvesse.airline.HelpOption
- groupNames - Variable in class com.github.rvesse.airline.model.CommandMetadata
- groupNames() - Method in annotation type com.github.rvesse.airline.annotations.Command
-
The group(s) this command should belong to.
- groupOptions - Variable in class com.github.rvesse.airline.model.CommandMetadata
- groupOptions - Variable in class com.github.rvesse.airline.model.MetadataLoader.InjectionMetadata
- groups - Variable in class com.github.rvesse.airline.builder.CliBuilder
- groups - Variable in class com.github.rvesse.airline.model.CommandMetadata
- groups() - Method in annotation type com.github.rvesse.airline.annotations.Cli
-
Defines command groups for the CLI
- Groups - Annotation Type in com.github.rvesse.airline.annotations
-
Marks a class as providing multiple command group metadata
- GroupSuggester - Class in com.github.rvesse.airline.help.suggester
- GroupSuggester() - Constructor for class com.github.rvesse.airline.help.suggester.GroupSuggester
H
- handleError(ParseException) - Method in class com.github.rvesse.airline.parser.errors.handlers.AbstractCollectingHandler
- handleError(ParseException) - Method in class com.github.rvesse.airline.parser.errors.handlers.FailFast
- handleError(ParseException) - Method in interface com.github.rvesse.airline.parser.errors.handlers.ParserErrorHandler
-
Handlers an error
- hangingIndent - Variable in class com.github.rvesse.airline.io.printers.UsagePrinter
- hardReset - Variable in class com.github.rvesse.airline.examples.io.ColorDemo
- hardReset - Variable in class com.github.rvesse.airline.examples.io.Decorations
- hasCause() - Method in class com.github.rvesse.airline.types.ConvertResult
-
Gets whether a cause is available
- hashCode() - Method in class com.github.rvesse.airline.Accessor
- hashCode() - Method in class com.github.rvesse.airline.model.ArgumentsMetadata
- hashCode() - Method in class com.github.rvesse.airline.model.OptionMetadata
- hasPrefix() - Method in class com.github.rvesse.airline.types.numerics.NumericCandidate
- hasShortNamePrefix(String) - Method in class com.github.rvesse.airline.parser.options.AbstractOptionParser
-
Return true if the option has a short name prefix i.e.
- hasSuffix() - Method in class com.github.rvesse.airline.types.numerics.NumericCandidate
- height - Variable in class com.github.rvesse.airline.examples.sendit.Package
- help - Variable in class com.github.rvesse.airline.examples.inheritance.Parent
- help - Variable in class com.github.rvesse.airline.examples.modules.ModuleReuse
- help - Variable in class com.github.rvesse.airline.examples.modules.Modules
- help - Variable in class com.github.rvesse.airline.examples.simple.Simple
-
The special
HelpOption
provides a-h
and--help
option that can be used to request that help be shown. - help - Variable in class com.github.rvesse.airline.HelpOption
- help - Variable in class com.github.rvesse.airline.jpms.debug.Debug
- help(CommandMetadata) - Static method in class com.github.rvesse.airline.help.Help
-
Displays plain text format help for the given command to standard out
- help(CommandMetadata, boolean) - Static method in class com.github.rvesse.airline.help.Help
-
Displays plain text format help for the given command to standard out
- help(CommandMetadata, boolean, OutputStream) - Static method in class com.github.rvesse.airline.help.Help
-
Displays plain text format help or the given command to the given output stream
- help(CommandMetadata, OutputStream) - Static method in class com.github.rvesse.airline.help.Help
-
Displays plain text format help or the given command to the given output stream
- help(GlobalMetadata<T>, List<String>) - Static method in class com.github.rvesse.airline.help.Help
-
Displays plain text format program help to standard out
- help(GlobalMetadata<T>, List<String>, boolean) - Static method in class com.github.rvesse.airline.help.Help
-
Displays plain text format program help to standard out
- help(GlobalMetadata<T>, List<String>, boolean, OutputStream) - Static method in class com.github.rvesse.airline.help.Help
-
Displays plain text format program help to the given output stream
- help(GlobalMetadata<T>, List<String>, OutputStream) - Static method in class com.github.rvesse.airline.help.Help
-
Displays plain text format program help to the given output stream
- Help - Class in com.github.rvesse.airline.examples.cli.commands
- Help<T> - Class in com.github.rvesse.airline.help
- Help() - Constructor for class com.github.rvesse.airline.examples.cli.commands.Help
- Help() - Constructor for class com.github.rvesse.airline.help.Help
- helper - Variable in class com.github.rvesse.airline.help.cli.CliCommandUsageGenerator
- helper - Variable in class com.github.rvesse.airline.help.cli.CliGlobalUsageGenerator
- helper - Variable in class com.github.rvesse.airline.help.cli.CliGlobalUsageSummaryGenerator
- helper - Variable in class com.github.rvesse.airline.help.man.ManCommandUsageGenerator
- helper - Variable in class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator
- helper - Variable in class com.github.rvesse.airline.help.markdown.MarkdownCommandUsageGenerator
- helper - Variable in class com.github.rvesse.airline.help.markdown.MarkdownGlobalUsageGenerator
- HelpFormat - Enum in com.github.rvesse.airline.help.sections
-
Enumeration of help formats, a
HelpSection
orHelpHint
may provide this but help generators are not obliged to follow this - HelpFormat() - Constructor for enum com.github.rvesse.airline.help.sections.HelpFormat
- HelpHint - Interface in com.github.rvesse.airline.help.sections
-
Interface for classes that provide additional help information
- HelpOption<C> - Class in com.github.rvesse.airline
-
An option that provides a simple way for the user to request help with a command
- HelpOption() - Constructor for class com.github.rvesse.airline.HelpOption
- HelpSection - Interface in com.github.rvesse.airline.help.sections
-
Interface for classes that represents additional help sections
- HelpSectionComparator - Class in com.github.rvesse.airline.utils.comparators
- HelpSectionComparator() - Constructor for class com.github.rvesse.airline.utils.comparators.HelpSectionComparator
- HelpSectionFactory - Interface in com.github.rvesse.airline.help.sections.factories
-
Interface for factories that convert annotations into
HelpSection
instances - HelpSectionRegistry - Class in com.github.rvesse.airline.help.sections.factories
-
Registry which maps annotations to help sections
- HelpSectionRegistry() - Constructor for class com.github.rvesse.airline.help.sections.factories.HelpSectionRegistry
- Hexadecimal - Class in com.github.rvesse.airline.types.numerics.bases
-
A type converter that supports hexadecimal numbers
- Hexadecimal() - Constructor for class com.github.rvesse.airline.types.numerics.bases.Hexadecimal
- hidden - Variable in class com.github.rvesse.airline.builder.GroupBuilder
- hidden - Variable in class com.github.rvesse.airline.model.CommandGroupMetadata
- hidden - Variable in class com.github.rvesse.airline.model.CommandMetadata
- hidden - Variable in class com.github.rvesse.airline.model.OptionMetadata
- hidden() - Method in annotation type com.github.rvesse.airline.annotations.Command
-
If true, this command won't appear in help
- hidden() - Method in annotation type com.github.rvesse.airline.annotations.Group
-
Whether the group should be hidden
- hidden() - Method in annotation type com.github.rvesse.airline.annotations.Option
-
If true, this parameter won't appear in the usage().
- hideGlobalOptions - Variable in class com.github.rvesse.airline.help.cli.CliCommandGroupUsageGenerator
- HideSection - Annotation Type in com.github.rvesse.airline.annotations.help
-
Annotation used to specify that a section that would otherwise be inherited from a parent class should be hidden
- highIntensity - Variable in enum com.github.rvesse.airline.io.colors.BasicColor
- hint - Variable in class com.github.rvesse.airline.restrictions.common.PartialRestriction
- hintComparator - Variable in class com.github.rvesse.airline.help.common.AbstractUsageGenerator
- holder() - Method in annotation type com.github.rvesse.airline.annotations.help.Copyright
-
Gets/Sets the copyright holder
- HomeDirectoryLocator - Class in com.github.rvesse.airline.parser.resources
-
A resource locator that allows the
~/
or~\
alias (depending on your platforms file separator) to be used to refer to the users home directory - HomeDirectoryLocator() - Constructor for class com.github.rvesse.airline.parser.resources.HomeDirectoryLocator
- houseName - Variable in class com.github.rvesse.airline.examples.sendit.PostalAddress
- houseNumber - Variable in class com.github.rvesse.airline.examples.sendit.PostalAddress
- HtmlCommandUsageGenerator - Class in com.github.rvesse.airline.help.html
-
A usage generator that generates HTML documentation
- HtmlCommandUsageGenerator() - Constructor for class com.github.rvesse.airline.help.html.HtmlCommandUsageGenerator
- HtmlCommandUsageGenerator(boolean) - Constructor for class com.github.rvesse.airline.help.html.HtmlCommandUsageGenerator
- HtmlCommandUsageGenerator(boolean, String...) - Constructor for class com.github.rvesse.airline.help.html.HtmlCommandUsageGenerator
- HtmlCommandUsageGenerator(String...) - Constructor for class com.github.rvesse.airline.help.html.HtmlCommandUsageGenerator
- HtmlCommandUsageGenerator(String, boolean) - Constructor for class com.github.rvesse.airline.help.html.HtmlCommandUsageGenerator
- HtmlCommandUsageGenerator(Comparator<? super OptionMetadata>, boolean, String...) - Constructor for class com.github.rvesse.airline.help.html.HtmlCommandUsageGenerator
- htmlize(String) - Method in class com.github.rvesse.airline.help.common.AbstractUsageGenerator
-
HTMLizes a string i.e.
I
- ignoreCase - Variable in class com.github.rvesse.airline.restrictions.common.AbstractLocaleAndCaseStringRestriction
- ignoreCase - Variable in class com.github.rvesse.airline.utils.predicates.PrefixMatcher
- ignoreCase - Variable in class com.github.rvesse.airline.utils.predicates.SuffixMatcher
- ignoreCase() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.AllowedRawValues
-
If true the case on
AllowedRawValues.allowedValues()
is ignored - ignoreCase() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.EndsWith
-
If true then case of the value is ignored
- ignoreCase() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.StartsWith
-
If true then case of the value is ignored
- IgnoresCaseMatcher<TOption> - Class in com.github.rvesse.airline.prompts.matchers
-
An option matcher that ignores case
- IgnoresCaseMatcher() - Constructor for class com.github.rvesse.airline.prompts.matchers.IgnoresCaseMatcher
- illegalValue - Variable in exception com.github.rvesse.airline.parser.errors.ParseArgumentsIllegalValueException
- illegalValue - Variable in exception com.github.rvesse.airline.parser.errors.ParseOptionIllegalValueException
- illegalValue - Variable in exception com.github.rvesse.airline.parser.errors.ParseOptionOutOfRangeException
- IMAGE_NEGATIVE - com.github.rvesse.airline.io.decorations.BasicDecoration
- IMAGE_NEGATIVE - Static variable in class com.github.rvesse.airline.io.AnsiControlCodes
- IMAGE_POSITIVE - Static variable in class com.github.rvesse.airline.io.AnsiControlCodes
- inAnyAcceptableRange(int) - Method in class com.github.rvesse.airline.restrictions.common.PortRestriction
- includeDefaultRestrictions() - Method in annotation type com.github.rvesse.airline.annotations.Cli
-
Sets whether the default global restrictions are applied
- includeHidden - Variable in class com.github.rvesse.airline.examples.cli.commands.BashCompletion
- includeHidden - Variable in class com.github.rvesse.airline.examples.cli.commands.Help
- includeHidden - Variable in class com.github.rvesse.airline.examples.cli.commands.Manuals
- includeHidden - Variable in class com.github.rvesse.airline.help.common.AbstractUsageGenerator
- includeHidden - Variable in class com.github.rvesse.airline.help.Help
- includeHidden() - Method in class com.github.rvesse.airline.help.common.AbstractUsageGenerator
-
Gets whether hidden commands and options should be included in the output
- includesZero() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.ranges.Negative
-
Sets whether zero is considered a negative number (default false)
- includesZero() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.ranges.Positive
-
Sets whether zero is considered a positive number (default true)
- includeZero - Variable in class com.github.rvesse.airline.restrictions.common.PositiveNegativeRestriction
- indent - Variable in class com.github.rvesse.airline.io.printers.UsagePrinter
- indent(Writer, int) - Method in class com.github.rvesse.airline.help.cli.bash.BashCompletionGenerator
- indentation - Variable in class com.github.rvesse.airline.io.printers.TroffPrinter
- index - Variable in enum com.github.rvesse.airline.io.colors.BasicColor
- IndexMatcher<TOption> - Class in com.github.rvesse.airline.prompts.matchers
-
An option matcher that matches options based on the numeric index of the option using 1 based indexes
- IndexMatcher() - Constructor for class com.github.rvesse.airline.prompts.matchers.IndexMatcher
- indices - Variable in class com.github.rvesse.airline.restrictions.common.PartialRestriction
- init - Static variable in class com.github.rvesse.airline.help.sections.factories.HelpSectionRegistry
- init - Static variable in class com.github.rvesse.airline.restrictions.factories.RestrictionRegistry
- init() - Static method in class com.github.rvesse.airline.help.sections.factories.HelpSectionRegistry
- init() - Static method in class com.github.rvesse.airline.restrictions.factories.RestrictionRegistry
-
Initializes the base set of restrictions using the
ServiceLoader
mechanism - injectionAnnotationClasses - Variable in class com.github.rvesse.airline.builder.ParserBuilder
- InjectionMetadata() - Constructor for class com.github.rvesse.airline.model.MetadataLoader.InjectionMetadata
- injectOptions(T, Iterable<OptionMetadata>, List<Pair<OptionMetadata, Object>>, ArgumentsMetadata, Iterable<Object>, Iterable<Accessor>, Map<Class<?>, Object>) - Static method in class com.github.rvesse.airline.parser.ParserUtil
- input() - Static method in class com.github.rvesse.airline.Channels
-
Returns input channel.
- inRange(int) - Method in enum com.github.rvesse.airline.annotations.restrictions.PortType
- inRange(int) - Method in interface com.github.rvesse.airline.restrictions.common.PortRange
-
Gets whether a port falls within the range
- inRange(int) - Method in class com.github.rvesse.airline.restrictions.common.PortRangeImpl
- inRange(Object) - Method in class com.github.rvesse.airline.restrictions.common.RangeRestriction
- inSection - Variable in class com.github.rvesse.airline.io.printers.TroffPrinter
- INTEGER_COMPARATOR - Static variable in class com.github.rvesse.airline.restrictions.factories.RangeRestrictionFactory
- IntegerComparator - Class in com.github.rvesse.airline.utils.comparators
- IntegerComparator() - Constructor for class com.github.rvesse.airline.utils.comparators.IntegerComparator
- IntegerRange - Annotation Type in com.github.rvesse.airline.annotations.restrictions.ranges
-
Annotation that marks values as being restricted to a given integer range
- integerRestrictor - Variable in class com.github.rvesse.airline.restrictions.common.PositiveNegativeRestriction
- internalCommands() - Method in annotation type com.github.rvesse.airline.annotations.help.SeeAlso
-
An array listing one or more internal commands, i.e.
- intersection(Set<T>, Set<T>) - Static method in class com.github.rvesse.airline.utils.AirlineUtils
- invalidArgumentsPort(ArgumentsMetadata, String, Object) - Method in class com.github.rvesse.airline.restrictions.common.PortRestriction
- invalidOptionPort(OptionMetadata, String, Object) - Method in class com.github.rvesse.airline.restrictions.common.PortRestriction
- invalidPort(String, Object) - Method in class com.github.rvesse.airline.restrictions.common.PortRestriction
- invalidResponse(String) - Static method in class com.github.rvesse.airline.prompts.matchers.MatcherUtils
-
Provides an error indicating that the response was invalid
- isAbbreviation(T) - Method in class com.github.rvesse.airline.utils.predicates.AbstractAbbreviationFinder
- isApplicableToArgument(ParseState<T>) - Method in class com.github.rvesse.airline.restrictions.common.PartialRestriction
- isApplicableToOption(ParseState<T>, OptionMetadata) - Method in class com.github.rvesse.airline.restrictions.common.PartialRestriction
- isBuildable() - Method in class com.github.rvesse.airline.builder.UserAliasSourceBuilder
- isCaseSensitive() - Method in class com.github.rvesse.airline.types.numerics.abbreviated.AbbreviatedNumericTypeConverter
- isCaseSensitive() - Method in class com.github.rvesse.airline.types.numerics.abbreviated.MapAbbreviatedNumericTypeConverter
- IsEnvVarSet() - Constructor for class com.github.rvesse.airline.restrictions.options.RequiredUnlessEnvironmentRestriction.IsEnvVarSet
- isExact(T) - Method in class com.github.rvesse.airline.utils.predicates.AbstractAbbreviationFinder
- isExactNameMatch(String, CommandGroupMetadata) - Method in class com.github.rvesse.airline.utils.predicates.parser.AbbreviatedGroupFinder
- isExactNameMatch(String, CommandMetadata) - Method in class com.github.rvesse.airline.utils.predicates.parser.AbbreviatedCommandFinder
- isExactNameMatch(String, OptionMetadata) - Method in class com.github.rvesse.airline.utils.predicates.parser.AbbreviatedOptionFinder
- isExactNameMatch(String, T) - Method in class com.github.rvesse.airline.utils.predicates.AbstractAbbreviationFinder
- isHidden() - Method in class com.github.rvesse.airline.model.CommandGroupMetadata
-
Gets whether the group is hidden
- isHidden() - Method in class com.github.rvesse.airline.model.CommandMetadata
- isHidden() - Method in class com.github.rvesse.airline.model.OptionMetadata
- isMaximumInclusive() - Method in exception com.github.rvesse.airline.parser.errors.ParseOptionOutOfRangeException
- isMinimumInclusive() - Method in exception com.github.rvesse.airline.parser.errors.ParseOptionOutOfRangeException
- isMultiValued() - Method in class com.github.rvesse.airline.Accessor
- isMultiValued() - Method in class com.github.rvesse.airline.model.ArgumentsMetadata
- isMultiValued() - Method in class com.github.rvesse.airline.model.OptionMetadata
- isOverride() - Method in class com.github.rvesse.airline.model.OptionMetadata
- isPartialNameMatch(String, CommandGroupMetadata) - Method in class com.github.rvesse.airline.utils.predicates.parser.AbbreviatedGroupFinder
- isPartialNameMatch(String, CommandMetadata) - Method in class com.github.rvesse.airline.utils.predicates.parser.AbbreviatedCommandFinder
- isPartialNameMatch(String, OptionMetadata) - Method in class com.github.rvesse.airline.utils.predicates.parser.AbbreviatedOptionFinder
- isPartialNameMatch(String, T) - Method in class com.github.rvesse.airline.utils.predicates.AbstractAbbreviationFinder
- isRequired() - Method in class com.github.rvesse.airline.model.ArgumentsMetadata
- isRequired() - Method in class com.github.rvesse.airline.model.OptionMetadata
- IsRequiredArgumentFinder - Class in com.github.rvesse.airline.utils.predicates.restrictions
- IsRequiredArgumentFinder() - Constructor for class com.github.rvesse.airline.utils.predicates.restrictions.IsRequiredArgumentFinder
- IsRequiredOptionFinder - Class in com.github.rvesse.airline.utils.predicates.restrictions
- IsRequiredOptionFinder() - Constructor for class com.github.rvesse.airline.utils.predicates.restrictions.IsRequiredOptionFinder
- IsRequiredRestriction - Class in com.github.rvesse.airline.restrictions.common
-
A restriction that options/arguments are required
- IsRequiredRestriction() - Constructor for class com.github.rvesse.airline.restrictions.common.IsRequiredRestriction
- isSealed() - Method in class com.github.rvesse.airline.model.OptionMetadata
- isSeparatorOrOption(ParseState<T>, List<OptionMetadata>, String, boolean, String) - Method in class com.github.rvesse.airline.parser.options.AbstractOptionParser
-
Checks whether the next value is an arguments separator or option
- isSeparatorOrOption(ParseState<T>, List<OptionMetadata>, String, boolean, String) - Method in class com.github.rvesse.airline.parser.options.GreedyClassicGetOptParser
- isValid(int) - Method in class com.github.rvesse.airline.restrictions.common.PortRestriction
- isValid(long) - Method in class com.github.rvesse.airline.restrictions.common.PortRestriction
- isValid(short) - Method in class com.github.rvesse.airline.restrictions.common.PortRestriction
- isValid(Object) - Method in class com.github.rvesse.airline.restrictions.common.PositiveNegativeRestriction
- isValid(String) - Method in class com.github.rvesse.airline.restrictions.common.AbstractStringRestriction
-
Method that derived classes must implement to check whether a value is valid
- isValid(String) - Method in class com.github.rvesse.airline.restrictions.common.EndsWithRestriction
- isValid(String) - Method in class com.github.rvesse.airline.restrictions.common.LengthRestriction
- isValid(String) - Method in class com.github.rvesse.airline.restrictions.common.NoOptionLikeValuesRestriction
- isValid(String) - Method in class com.github.rvesse.airline.restrictions.common.NotBlankRestriction
- isValid(String) - Method in class com.github.rvesse.airline.restrictions.common.NotEmptyRestriction
- isValid(String) - Method in class com.github.rvesse.airline.restrictions.common.StartsWithRestriction
- italic - Variable in class com.github.rvesse.airline.io.output.ColorizedOutputStream
- italic - Variable in class com.github.rvesse.airline.io.writers.ColorizedWriter
- ITALIC - com.github.rvesse.airline.io.decorations.BasicDecoration
- ITALIC - Static variable in class com.github.rvesse.airline.io.AnsiControlCodes
- ITALIC_OFF - Static variable in class com.github.rvesse.airline.io.AnsiControlCodes
- item - Variable in class com.github.rvesse.airline.examples.sendit.Price
- item - Variable in class com.github.rvesse.airline.examples.sendit.Send
J
- JAKARTA_INJECT_INJECT - Static variable in class com.github.rvesse.airline.model.MetadataLoader
-
Constant for the
jakarta.inject.Inject
annotation class - javaType - Variable in class com.github.rvesse.airline.Accessor
- JAVAX_INJECT_INJECT - Static variable in class com.github.rvesse.airline.model.MetadataLoader
-
Constant for the
javax.inject.Inject
annotation class - JdbcStyleOptionParser<T> - Class in com.github.rvesse.airline.examples.userguide.parser.options
-
Option parser that parses options given in JDBC connection URL style e.g.
- JdbcStyleOptionParser() - Constructor for class com.github.rvesse.airline.examples.userguide.parser.options.JdbcStyleOptionParser
- JpmsResourceLocator - Class in com.github.rvesse.airline.parser.resources.jpms
-
A resource locator that finds resources using
ClassGraph
that works in JPMS runtime contexts where the standardClasspathLocator
does not. - JpmsResourceLocator() - Constructor for class com.github.rvesse.airline.parser.resources.jpms.JpmsResourceLocator
- Json - com.github.rvesse.airline.examples.cli.aliases.Logs.Format
- JvmSystemPropertyLocator - Class in com.github.rvesse.airline.parser.resources
-
A resource locator that allows references to JVM system properties using
${property}
references to locate resources referred to in those properties - JvmSystemPropertyLocator() - Constructor for class com.github.rvesse.airline.parser.resources.JvmSystemPropertyLocator
K
- KiloAs1000 - Class in com.github.rvesse.airline.types.numerics.abbreviated
-
A numeric type converter that supports standard using suffixes -
k m b t
- to abbreviate numbers expressed in terms of thousands, millions, billions or trillions - KiloAs1000() - Constructor for class com.github.rvesse.airline.types.numerics.abbreviated.KiloAs1000
- KiloAs1024 - Class in com.github.rvesse.airline.types.numerics.abbreviated
-
A numeric type converter that supports suffixes used to denote base 2 kilo units
- KiloAs1024() - Constructor for class com.github.rvesse.airline.types.numerics.abbreviated.KiloAs1024
- kind - Variable in class com.github.rvesse.airline.restrictions.common.PathRestriction
- kind() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.Path
-
Gets/Sets the kind of file that is expected
L
- last(Iterable<T>) - Static method in class com.github.rvesse.airline.utils.AirlineUtils
- last(Iterable<T>, T) - Static method in class com.github.rvesse.airline.utils.AirlineUtils
- last(Iterator<T>) - Static method in class com.github.rvesse.airline.utils.AirlineUtils
- last(Iterator<T>, T) - Static method in class com.github.rvesse.airline.utils.AirlineUtils
- length() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.ExactLength
-
Exact required length in characters
- length() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.MaxLength
-
Maximum allowed length (inclusive)
- length() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.MinLength
-
Minimum required length (inclusive)
- LengthRange - Annotation Type in com.github.rvesse.airline.annotations.restrictions.ranges
-
Annotation that marks values as being restricted to a given length range i.e.
- LengthRestriction - Class in com.github.rvesse.airline.restrictions.common
-
A restriction that requires string values meet length constraints
- LengthRestriction(int, boolean) - Constructor for class com.github.rvesse.airline.restrictions.common.LengthRestriction
-
Creates a length restriction with either a minimum or maximum
- LengthRestriction(int, int) - Constructor for class com.github.rvesse.airline.restrictions.common.LengthRestriction
-
Creates a length restriction with a minimum and maximum i.e.
- level - Variable in class com.github.rvesse.airline.io.printers.TroffPrinter
- LexicalComparator - Class in com.github.rvesse.airline.utils.comparators
- LexicalComparator(Locale) - Constructor for class com.github.rvesse.airline.utils.comparators.LexicalComparator
- LexicalRange - Annotation Type in com.github.rvesse.airline.annotations.restrictions.ranges
-
Annotation that marks values as being restricted to a given lexical range
- License - Annotation Type in com.github.rvesse.airline.annotations.help
-
Annotation that provides a license statement in a commands help
- lineBreak() - Method in class com.github.rvesse.airline.io.printers.TroffPrinter
- LIST - com.github.rvesse.airline.help.sections.HelpFormat
-
Help format is a list, each content block represents a separate list
- listCopy(Iterable<T>) - Static method in class com.github.rvesse.airline.utils.AirlineUtils
- listCopy(Collection<T>) - Static method in class com.github.rvesse.airline.utils.AirlineUtils
- ListFormat<TOption> - Class in com.github.rvesse.airline.prompts.formatters
-
A prompt formatter that presents a list of options
- ListFormat() - Constructor for class com.github.rvesse.airline.prompts.formatters.ListFormat
-
Creates a new list format with default columns
- ListFormat(int) - Constructor for class com.github.rvesse.airline.prompts.formatters.ListFormat
-
Creates a new list format with the specified number of columns
- ListFormatBuilder<TOption> - Class in com.github.rvesse.airline.prompts.builders
-
A builder that helps building list formats
- ListFormatBuilder(PromptBuilder<TOption>) - Constructor for class com.github.rvesse.airline.prompts.builders.ListFormatBuilder
- listGlyph - Variable in class com.github.rvesse.airline.io.printers.TroffPrinter
- lists - Variable in class com.github.rvesse.airline.io.printers.TroffPrinter
- ListType() - Constructor for enum com.github.rvesse.airline.io.printers.TroffPrinter.ListType
- ListValueOptionParser<T> - Class in com.github.rvesse.airline.parser.options
-
An options parser that requires the values to be a non-whitespace separated list
- ListValueOptionParser() - Constructor for class com.github.rvesse.airline.parser.options.ListValueOptionParser
- ListValueOptionParser(char) - Constructor for class com.github.rvesse.airline.parser.options.ListValueOptionParser
- load() - Method in class com.github.rvesse.airline.parser.aliases.UserAliasesSource
-
Loads the alias metadata based on the configured sources
- loadCommand(Class<?>, ParserMetadata<?>) - Static method in class com.github.rvesse.airline.model.MetadataLoader
-
Loads command meta-data
- loadCommand(Class<?>, Map<String, HelpSection>, ParserMetadata<?>) - Static method in class com.github.rvesse.airline.model.MetadataLoader
-
Loads command meta-data
- loadCommandGroup(String, String, boolean, Iterable<CommandGroupMetadata>, CommandMetadata, Iterable<CommandMetadata>) - Static method in class com.github.rvesse.airline.model.MetadataLoader
-
Loads command group meta-data
- loadCommands(Iterable<Class<? extends T>>, Map<String, HelpSection>, ParserMetadata<?>) - Static method in class com.github.rvesse.airline.model.MetadataLoader
-
Loads command meta-data
- loadCommandsIntoGroupsByAnnotation(List<CommandMetadata>, List<CommandGroupMetadata>, List<CommandMetadata>, Map<String, HelpSection>, ParserMetadata<?>) - Static method in class com.github.rvesse.airline.model.MetadataLoader
- loadDataSource(ResourceLocator[], String) - Method in class com.github.rvesse.airline.help.sections.common.VersionSection
- loadGlobal(Class<?>) - Static method in class com.github.rvesse.airline.model.MetadataLoader
- loadGlobal(Class<?>, ParserMetadata<C>) - Static method in class com.github.rvesse.airline.model.MetadataLoader
-
Loads the metadata for a CLI
- loadGlobal(String, String, CommandMetadata, Iterable<CommandMetadata>, Iterable<CommandGroupMetadata>, Iterable<GlobalRestriction>, Iterable<HelpSection>, ParserMetadata<C>) - Static method in class com.github.rvesse.airline.model.MetadataLoader
-
Loads global meta-data
- loadHelpSections(Class<?>, Map<String, HelpSection>) - Static method in class com.github.rvesse.airline.model.MetadataLoader
- loadInjectionMetadata(Class<?>, MetadataLoader.InjectionMetadata, List<Field>, ParserMetadata<?>) - Static method in class com.github.rvesse.airline.model.MetadataLoader
-
Loads injection meta-data
- loadInjectionMetadata(Class<?>, ParserMetadata<?>) - Static method in class com.github.rvesse.airline.model.MetadataLoader
-
Loads injection meta-data
- loadParagraphsParser(Class<? extends ParagraphsParser>) - Method in class com.github.rvesse.airline.help.external.factories.ExternalHelpFactory
-
Loads the paragraphs parser
- loadParser(Parser) - Static method in class com.github.rvesse.airline.model.MetadataLoader
- loadParser(Class<?>) - Static method in class com.github.rvesse.airline.model.MetadataLoader
- loadPartials(Field) - Static method in class com.github.rvesse.airline.model.MetadataLoader
- loadRestrictions(Class<T>, Function<T, List<Class<? extends Annotation>>>, Map<Class<? extends Annotation>, T>) - Static method in class com.github.rvesse.airline.restrictions.factories.RestrictionRegistry
- loadSuggester(Class<? extends Suggester>, ParserMetadata<?>) - Static method in class com.github.rvesse.airline.model.MetadataLoader
-
Loads suggester meta-data
- loadTabularParser(Class<? extends TabularParser>) - Method in class com.github.rvesse.airline.help.external.factories.ExternalHelpFactory
-
Loads the tabular parser
- locale - Variable in class com.github.rvesse.airline.restrictions.common.AbstractLocaleAndCaseStringRestriction
- locale - Variable in class com.github.rvesse.airline.restrictions.common.AllowedRawValuesRestriction
- locale - Variable in class com.github.rvesse.airline.utils.predicates.AbstractLocaleSensitiveStringFinder
- locale() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.AllowedRawValues
-
The locale used for comparisons
- locale() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.EndsWith
-
The locale used for comparisons
- locale() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.ranges.LexicalRange
-
The locale used for comparisons
- locale() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.StartsWith
-
The locale used for comparisons
- LocaleSensitiveStringFinder - Class in com.github.rvesse.airline.utils.predicates
- LocaleSensitiveStringFinder(String, Locale) - Constructor for class com.github.rvesse.airline.utils.predicates.LocaleSensitiveStringFinder
- locationStack - Variable in class com.github.rvesse.airline.parser.ParseState
- locators - Variable in class com.github.rvesse.airline.builder.UserAliasSourceBuilder
- locators - Variable in class com.github.rvesse.airline.parser.aliases.UserAliasesSource
- Logs - Class in com.github.rvesse.airline.examples.cli.aliases
- Logs() - Constructor for class com.github.rvesse.airline.examples.cli.aliases.Logs
- Logs.Format - Enum in com.github.rvesse.airline.examples.cli.aliases
- LONG_COMPARATOR - Static variable in class com.github.rvesse.airline.restrictions.factories.RangeRestrictionFactory
- LongComparator - Class in com.github.rvesse.airline.utils.comparators
- LongComparator() - Constructor for class com.github.rvesse.airline.utils.comparators.LongComparator
- LongGetOptParser<T> - Class in com.github.rvesse.airline.parser.options
-
An options parser that supports the GNU Get Opt long style i.e.
- LongGetOptParser() - Constructor for class com.github.rvesse.airline.parser.options.LongGetOptParser
- LongRange - Annotation Type in com.github.rvesse.airline.annotations.restrictions.ranges
-
Annotation that marks values as being restricted to a given long integer range
- longRestrictor - Variable in class com.github.rvesse.airline.restrictions.common.PositiveNegativeRestriction
M
- MAGENTA - com.github.rvesse.airline.io.colors.BasicColor
- main(String[]) - Static method in class com.github.rvesse.airline.examples.cli.AbbreviationCli
- main(String[]) - Static method in class com.github.rvesse.airline.examples.cli.aliases.AliasedCli
- main(String[]) - Static method in class com.github.rvesse.airline.examples.cli.aliases.PositionalAliasedCli
- main(String[]) - Static method in class com.github.rvesse.airline.examples.cli.aliases.UserAliasedCli
- main(String[]) - Static method in class com.github.rvesse.airline.examples.cli.CompletionCli
- main(String[]) - Static method in class com.github.rvesse.airline.examples.cli.DefaultCli
- main(String[]) - Static method in class com.github.rvesse.airline.examples.cli.GroupCli
- main(String[]) - Static method in class com.github.rvesse.airline.examples.cli.SimpleCli
- main(String[]) - Static method in class com.github.rvesse.airline.examples.inheritance.BadGrandchild
- main(String[]) - Static method in class com.github.rvesse.airline.examples.inheritance.Child
- main(String[]) - Static method in class com.github.rvesse.airline.examples.inheritance.GoodGrandchild
- main(String[]) - Static method in class com.github.rvesse.airline.examples.inheritance.MaybeVerboseCommand
- main(String[]) - Static method in class com.github.rvesse.airline.examples.inheritance.Parent
- main(String[]) - Static method in class com.github.rvesse.airline.examples.io.Colors256
- main(String[]) - Static method in class com.github.rvesse.airline.examples.io.ColorsBasic
- main(String[]) - Static method in class com.github.rvesse.airline.examples.io.ColorsTrue
- main(String[]) - Static method in class com.github.rvesse.airline.examples.io.Decorations
- main(String[]) - Static method in class com.github.rvesse.airline.examples.modules.ModuleReuse
- main(String[]) - Static method in class com.github.rvesse.airline.examples.modules.Modules
- main(String[]) - Static method in class com.github.rvesse.airline.examples.sendit.GenerateHelp
- main(String[]) - Static method in class com.github.rvesse.airline.examples.sendit.Send
- main(String[]) - Static method in class com.github.rvesse.airline.examples.sendit.SendIt
- main(String[]) - Static method in class com.github.rvesse.airline.examples.simple.Paths
- main(String[]) - Static method in class com.github.rvesse.airline.examples.simple.Required
- main(String[]) - Static method in class com.github.rvesse.airline.examples.simple.RequiredArguments
- main(String[]) - Static method in class com.github.rvesse.airline.examples.simple.Simple
- main(String[]) - Static method in class com.github.rvesse.airline.examples.userguide.BasicCli
- main(String[]) - Static method in class com.github.rvesse.airline.examples.userguide.GettingStarted
- main(String[]) - Static method in class com.github.rvesse.airline.examples.userguide.help.sections.Discussed
- main(String[]) - Static method in class com.github.rvesse.airline.examples.userguide.help.sections.ExternalHelp
- main(String[]) - Static method in class com.github.rvesse.airline.examples.userguide.parser.ByteCalculator
- main(String[]) - Static method in class com.github.rvesse.airline.examples.userguide.parser.options.JdbcStyleOptionParser
- main(String[]) - Static method in class com.github.rvesse.airline.examples.userguide.prompts.PromptsDemo
- main(String[]) - Static method in class com.github.rvesse.airline.examples.userguide.restrictions.OptionalOption
- main(String[]) - Static method in class com.github.rvesse.airline.examples.userguide.restrictions.RequiredOption
- main(String[]) - Static method in class com.github.rvesse.airline.jpms.debug.Debug
- makeHidden() - Method in class com.github.rvesse.airline.builder.GroupBuilder
- makeVisible() - Method in class com.github.rvesse.airline.builder.GroupBuilder
- ManCommandUsageGenerator - Class in com.github.rvesse.airline.help.man
-
A command usage generator which generates help in man page (Troff) format
- ManCommandUsageGenerator() - Constructor for class com.github.rvesse.airline.help.man.ManCommandUsageGenerator
- ManCommandUsageGenerator(int, boolean) - Constructor for class com.github.rvesse.airline.help.man.ManCommandUsageGenerator
-
Creates a new man page usage generator
- ManGlobalUsageGenerator<T> - Class in com.github.rvesse.airline.help.man
-
A global usage generator which generates Man pages in Troff format
- ManGlobalUsageGenerator() - Constructor for class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator
- ManGlobalUsageGenerator(int) - Constructor for class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator
- ManGlobalUsageGenerator(int, boolean) - Constructor for class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator
- ManGlobalUsageGenerator(int, boolean, CommandUsageGenerator) - Constructor for class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator
- ManMultiPageGlobalUsageGenerator<T> - Class in com.github.rvesse.airline.help.man
- ManMultiPageGlobalUsageGenerator() - Constructor for class com.github.rvesse.airline.help.man.ManMultiPageGlobalUsageGenerator
- ManMultiPageGlobalUsageGenerator(int) - Constructor for class com.github.rvesse.airline.help.man.ManMultiPageGlobalUsageGenerator
- ManMultiPageGlobalUsageGenerator(int, boolean) - Constructor for class com.github.rvesse.airline.help.man.ManMultiPageGlobalUsageGenerator
- ManMultiPageGlobalUsageGenerator(int, boolean, CommandUsageGenerator, File) - Constructor for class com.github.rvesse.airline.help.man.ManMultiPageGlobalUsageGenerator
- ManMultiPageGlobalUsageGenerator(int, boolean, File) - Constructor for class com.github.rvesse.airline.help.man.ManMultiPageGlobalUsageGenerator
- manSection - Variable in class com.github.rvesse.airline.help.man.ManCommandUsageGenerator
- manSection - Variable in class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator
- ManSections - Class in com.github.rvesse.airline.help.man
-
Standard man page section numbers
- ManSections() - Constructor for class com.github.rvesse.airline.help.man.ManSections
- Manuals - Class in com.github.rvesse.airline.examples.cli.commands
- Manuals() - Constructor for class com.github.rvesse.airline.examples.cli.commands.Manuals
- ManUsageHelper - Class in com.github.rvesse.airline.help.man
- ManUsageHelper(Comparator<? super OptionMetadata>, boolean) - Constructor for class com.github.rvesse.airline.help.man.ManUsageHelper
- MapAbbreviatedNumericTypeConverter - Class in com.github.rvesse.airline.types.numerics.abbreviated
- MapAbbreviatedNumericTypeConverter(boolean, Map<String, Integer>, Map<String, Long>) - Constructor for class com.github.rvesse.airline.types.numerics.abbreviated.MapAbbreviatedNumericTypeConverter
- MarkdownCommandUsageGenerator - Class in com.github.rvesse.airline.help.markdown
- MarkdownCommandUsageGenerator() - Constructor for class com.github.rvesse.airline.help.markdown.MarkdownCommandUsageGenerator
- MarkdownCommandUsageGenerator(boolean) - Constructor for class com.github.rvesse.airline.help.markdown.MarkdownCommandUsageGenerator
- MarkdownCommandUsageGenerator(int) - Constructor for class com.github.rvesse.airline.help.markdown.MarkdownCommandUsageGenerator
- MarkdownCommandUsageGenerator(int, boolean) - Constructor for class com.github.rvesse.airline.help.markdown.MarkdownCommandUsageGenerator
- MarkdownCommandUsageGenerator(int, Comparator<? super OptionMetadata>, boolean) - Constructor for class com.github.rvesse.airline.help.markdown.MarkdownCommandUsageGenerator
- MarkdownGlobalUsageGenerator<T> - Class in com.github.rvesse.airline.help.markdown
- MarkdownGlobalUsageGenerator() - Constructor for class com.github.rvesse.airline.help.markdown.MarkdownGlobalUsageGenerator
- MarkdownGlobalUsageGenerator(boolean) - Constructor for class com.github.rvesse.airline.help.markdown.MarkdownGlobalUsageGenerator
- MarkdownGlobalUsageGenerator(int) - Constructor for class com.github.rvesse.airline.help.markdown.MarkdownGlobalUsageGenerator
- MarkdownGlobalUsageGenerator(int, boolean) - Constructor for class com.github.rvesse.airline.help.markdown.MarkdownGlobalUsageGenerator
- MarkdownGlobalUsageGenerator(int, Comparator<? super HelpHint>, Comparator<? super OptionMetadata>, Comparator<? super CommandMetadata>, Comparator<? super CommandGroupMetadata>, boolean, AbstractPrintedCommandUsageGenerator) - Constructor for class com.github.rvesse.airline.help.markdown.MarkdownGlobalUsageGenerator
- MarkdownMultiPageGlobalUsageGenerator<T> - Class in com.github.rvesse.airline.help.markdown
- MarkdownMultiPageGlobalUsageGenerator() - Constructor for class com.github.rvesse.airline.help.markdown.MarkdownMultiPageGlobalUsageGenerator
- MarkdownMultiPageGlobalUsageGenerator(boolean) - Constructor for class com.github.rvesse.airline.help.markdown.MarkdownMultiPageGlobalUsageGenerator
- MarkdownMultiPageGlobalUsageGenerator(int, boolean) - Constructor for class com.github.rvesse.airline.help.markdown.MarkdownMultiPageGlobalUsageGenerator
- MarkdownMultiPageGlobalUsageGenerator(int, boolean, AbstractPrintedCommandUsageGenerator, File) - Constructor for class com.github.rvesse.airline.help.markdown.MarkdownMultiPageGlobalUsageGenerator
- MarkdownMultiPageGlobalUsageGenerator(int, boolean, File) - Constructor for class com.github.rvesse.airline.help.markdown.MarkdownMultiPageGlobalUsageGenerator
- MarkdownUsageHelper - Class in com.github.rvesse.airline.help.markdown
- MarkdownUsageHelper(Comparator<? super OptionMetadata>, boolean) - Constructor for class com.github.rvesse.airline.help.markdown.MarkdownUsageHelper
- match(Prompt<TOption>, String) - Method in class com.github.rvesse.airline.prompts.matchers.DefaultMatcher
- match(Prompt<TOption>, String) - Method in class com.github.rvesse.airline.prompts.matchers.IndexMatcher
- match(Prompt<TOption>, String) - Method in interface com.github.rvesse.airline.prompts.matchers.PromptOptionMatcher
-
Matches the response to an option provided by the prompt
- match(Prompt<TOption>, String) - Method in class com.github.rvesse.airline.prompts.matchers.ValueMatcher
- matcher - Variable in class com.github.rvesse.airline.restrictions.common.EndsWithRestriction
- matcher - Variable in class com.github.rvesse.airline.restrictions.common.StartsWithRestriction
- MatcherUtils - Class in com.github.rvesse.airline.prompts.matchers
-
Option matcher utility functions
- MatcherUtils() - Constructor for class com.github.rvesse.airline.prompts.matchers.MatcherUtils
- MatcherUtils.Exact<TOption> - Class in com.github.rvesse.airline.prompts.matchers
- MatcherUtils.ExactIgnoresCase<TOption> - Class in com.github.rvesse.airline.prompts.matchers
- MatcherUtils.ExactOrStartsWith<TOption> - Class in com.github.rvesse.airline.prompts.matchers
- MatcherUtils.ExactOrStartsWithIgnoresCase<TOption> - Class in com.github.rvesse.airline.prompts.matchers
- max - Variable in enum com.github.rvesse.airline.annotations.restrictions.PortType
- max - Variable in exception com.github.rvesse.airline.parser.errors.ParseOptionOutOfRangeException
- max - Variable in class com.github.rvesse.airline.restrictions.common.LengthRestriction
- max - Variable in class com.github.rvesse.airline.restrictions.common.PortRangeImpl
- max - Variable in class com.github.rvesse.airline.restrictions.common.RangeRestriction
- max() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.ranges.ByteRange
-
Maximum value
- max() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.ranges.DoubleRange
-
Maximum value
- max() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.ranges.FloatRange
-
Maximum value
- max() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.ranges.IntegerRange
-
Maximum value
- max() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.ranges.LengthRange
-
Maximum value
- max() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.ranges.LexicalRange
-
Maximum value, the empty string is interpreted as no maximum
- max() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.ranges.LongRange
-
Maximum value
- max() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.ranges.ShortRange
-
Maximum value
- MAX_PORT - Static variable in class com.github.rvesse.airline.restrictions.common.PortRestriction
- maximum - Variable in class com.github.rvesse.airline.restrictions.common.LengthRestriction
- maximum - Variable in class com.github.rvesse.airline.restrictions.common.OccurrencesRestriction
- maximum() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.PortRange
-
Sets the maximum port (inclusive)
- maxInclusive - Variable in exception com.github.rvesse.airline.parser.errors.ParseOptionOutOfRangeException
- maxInclusive - Variable in class com.github.rvesse.airline.restrictions.common.RangeRestriction
- maxInclusive() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.ranges.ByteRange
-
Whether the maximum value is inclusive
- maxInclusive() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.ranges.DoubleRange
-
Whether the maximum value is inclusive
- maxInclusive() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.ranges.FloatRange
-
Whether the maximum value is inclusive
- maxInclusive() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.ranges.IntegerRange
-
Whether the maximum value is inclusive
- maxInclusive() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.ranges.LexicalRange
-
Whether the maximum is inclusive
- maxInclusive() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.ranges.LongRange
-
Whether the maximum value is inclusive
- maxInclusive() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.ranges.ShortRange
-
Whether the maximum value is inclusive
- MaxLength - Annotation Type in com.github.rvesse.airline.annotations.restrictions
-
Annotation that marks that an options value is restricted to a maximum length (which is inclusive)
- MaxOccurrences - Annotation Type in com.github.rvesse.airline.annotations.restrictions
-
Annotation that marks an option as being restricted to occurring some maximum number of times (inclusive)
- maxSize - Variable in class com.github.rvesse.airline.io.printers.UsagePrinter
- MaybeListValueOptionParser<T> - Class in com.github.rvesse.airline.parser.options
-
An options parser that expects the name and value(s) to be white space separated e.g.
- MaybeListValueOptionParser() - Constructor for class com.github.rvesse.airline.parser.options.MaybeListValueOptionParser
- MaybeListValueOptionParser(char) - Constructor for class com.github.rvesse.airline.parser.options.MaybeListValueOptionParser
- MaybePairValueOptionParser<T> - Class in com.github.rvesse.airline.parser.options
-
An options parser that expects the name and values to be white space separated e.g.
- MaybePairValueOptionParser() - Constructor for class com.github.rvesse.airline.parser.options.MaybePairValueOptionParser
- MaybePairValueOptionParser(char) - Constructor for class com.github.rvesse.airline.parser.options.MaybePairValueOptionParser
- MaybeVerboseCommand - Class in com.github.rvesse.airline.examples.inheritance
- MaybeVerboseCommand() - Constructor for class com.github.rvesse.airline.examples.inheritance.MaybeVerboseCommand
- mergeOptionSet(List<OptionMetadata>) - Static method in class com.github.rvesse.airline.model.MetadataLoader
- message - Variable in class com.github.rvesse.airline.prompts.builders.PromptBuilder
- message - Variable in class com.github.rvesse.airline.prompts.Prompt
- metadata - Variable in class com.github.rvesse.airline.Cli
- metadata - Variable in class com.github.rvesse.airline.examples.userguide.help.sections.Discussed
- metadata - Variable in class com.github.rvesse.airline.examples.userguide.help.sections.ExternalHelp
- metadata - Variable in class com.github.rvesse.airline.help.suggester.GlobalSuggester
- metadata - Variable in class com.github.rvesse.airline.help.suggester.SuggestCommand
- metadataInjections - Variable in class com.github.rvesse.airline.model.CommandMetadata
- metadataInjections - Variable in class com.github.rvesse.airline.model.MetadataLoader.InjectionMetadata
- metadataInjections - Variable in class com.github.rvesse.airline.model.SuggesterMetadata
- MetadataLoader - Class in com.github.rvesse.airline.model
-
Helper for loading meta-data
- MetadataLoader() - Constructor for class com.github.rvesse.airline.model.MetadataLoader
- MetadataLoader.InjectionMetadata - Class in com.github.rvesse.airline.model
- min - Variable in enum com.github.rvesse.airline.annotations.restrictions.PortType
- min - Variable in exception com.github.rvesse.airline.parser.errors.ParseOptionOutOfRangeException
- min - Variable in class com.github.rvesse.airline.restrictions.common.LengthRestriction
- min - Variable in class com.github.rvesse.airline.restrictions.common.PortRangeImpl
- min - Variable in class com.github.rvesse.airline.restrictions.common.RangeRestriction
- min() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.ranges.ByteRange
-
Minimum value
- min() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.ranges.DoubleRange
-
Minimum value
- min() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.ranges.FloatRange
-
Minimum value
- min() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.ranges.IntegerRange
-
Minimum value
- min() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.ranges.LengthRange
-
Minimum value
- min() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.ranges.LexicalRange
-
Minimum value, the empty string is interpreted as no minimum
- min() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.ranges.LongRange
-
Minimum value
- min() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.ranges.ShortRange
-
Minimum value
- MIN_PORT - Static variable in class com.github.rvesse.airline.restrictions.common.PortRestriction
- minimum() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.PortRange
-
Sets the minimum port (inclusive)
- minInclusive - Variable in exception com.github.rvesse.airline.parser.errors.ParseOptionOutOfRangeException
- minInclusive - Variable in class com.github.rvesse.airline.restrictions.common.RangeRestriction
- minInclusive() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.ranges.ByteRange
-
Whether the minimum value is inclusive
- minInclusive() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.ranges.DoubleRange
-
Whether the minimum value is inclusive
- minInclusive() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.ranges.FloatRange
-
Whether the minimum value is inclusive
- minInclusive() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.ranges.IntegerRange
-
Whether the minimum value is inclusive
- minInclusive() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.ranges.LexicalRange
-
Whether the minimum is inclusive
- minInclusive() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.ranges.LongRange
-
Whether the minimum value is inclusive
- minInclusive() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.ranges.ShortRange
-
Whether the minimum value is inclusive
- MinLength - Annotation Type in com.github.rvesse.airline.annotations.restrictions
-
Annotation that marks that an options value is restricted to a minimum length (which is inclusive)
- MinOccurrences - Annotation Type in com.github.rvesse.airline.annotations.restrictions
-
Annotation that marks an option as being required to occur some minimum number of times (inclusive)
- MISCELLANEOUS - Static variable in class com.github.rvesse.airline.help.man.ManSections
-
Miscellaneous
- ModulePathLocator - Class in com.github.rvesse.airline.parser.resources
- ModulePathLocator() - Constructor for class com.github.rvesse.airline.parser.resources.ModulePathLocator
- ModuleReuse - Class in com.github.rvesse.airline.examples.modules
-
Here we have another command which reuses module classes we've defined and also adds locally defined options, we can
- ModuleReuse() - Constructor for class com.github.rvesse.airline.examples.modules.ModuleReuse
- modules - Variable in class com.github.rvesse.airline.jpms.debug.Debug
- Modules - Class in com.github.rvesse.airline.examples.modules
-
If you have some set of options that make sense together you can modularize them out as a class and inject them into your actual command class
- Modules() - Constructor for class com.github.rvesse.airline.examples.modules.Modules
- multipleOf - Variable in class com.github.rvesse.airline.examples.userguide.restrictions.custom.MultipleOfRestriction
- MultipleOf - Annotation Type in com.github.rvesse.airline.examples.userguide.restrictions.custom
- MultipleOfRestriction - Class in com.github.rvesse.airline.examples.userguide.restrictions.custom
- MultipleOfRestriction(int) - Constructor for class com.github.rvesse.airline.examples.userguide.restrictions.custom.MultipleOfRestriction
- MultipleRestrictionFactory - Class in com.github.rvesse.airline.examples.userguide.restrictions.custom
- MultipleRestrictionFactory() - Constructor for class com.github.rvesse.airline.examples.userguide.restrictions.custom.MultipleRestrictionFactory
- MultiSequenceAbbreviatedNumericTypeConverter - Class in com.github.rvesse.airline.types.numerics.abbreviated
- MultiSequenceAbbreviatedNumericTypeConverter(boolean, Map<String, Integer>, long, String[][]) - Constructor for class com.github.rvesse.airline.types.numerics.abbreviated.MultiSequenceAbbreviatedNumericTypeConverter
- multiValued - Variable in class com.github.rvesse.airline.Accessor
- mustExist - Variable in class com.github.rvesse.airline.restrictions.common.PathRestriction
- mustExist() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.Directory
-
Gets/Sets whether the given directory must exist
- mustExist() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.File
-
Gets/Sets whether the given file must exist
- mustExist() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.Path
-
Gets/Sets whether the given file must exist
- mutuallyExclusive - Variable in class com.github.rvesse.airline.restrictions.options.RequireFromRestriction
- MutuallyExclusiveRestriction - Class in com.github.rvesse.airline.restrictions.options
- MutuallyExclusiveRestriction(String) - Constructor for class com.github.rvesse.airline.restrictions.options.MutuallyExclusiveRestriction
- MutuallyExclusiveWith - Annotation Type in com.github.rvesse.airline.annotations.restrictions
-
Annotation that indicates that you optionally permit one option from some set of options to be present, the set of options are identified by a user defined tag.
- MutuallyExclusiveWithFinder - Class in com.github.rvesse.airline.utils.predicates.restrictions
- MutuallyExclusiveWithFinder() - Constructor for class com.github.rvesse.airline.utils.predicates.restrictions.MutuallyExclusiveWithFinder
- MutuallyExclusiveWithFinder(String) - Constructor for class com.github.rvesse.airline.utils.predicates.restrictions.MutuallyExclusiveWithFinder
- MutuallyExclusiveWithOptionFinder - Class in com.github.rvesse.airline.utils.predicates.restrictions
- MutuallyExclusiveWithOptionFinder(String) - Constructor for class com.github.rvesse.airline.utils.predicates.restrictions.MutuallyExclusiveWithOptionFinder
- MutuallyExclusiveWithTagParsedOptionFinder - Class in com.github.rvesse.airline.utils.predicates.restrictions
- MutuallyExclusiveWithTagParsedOptionFinder(String) - Constructor for class com.github.rvesse.airline.utils.predicates.restrictions.MutuallyExclusiveWithTagParsedOptionFinder
N
- name - Variable in class com.github.rvesse.airline.Accessor
- name - Variable in class com.github.rvesse.airline.builder.AliasBuilder
- name - Variable in class com.github.rvesse.airline.builder.CliBuilder
- name - Variable in class com.github.rvesse.airline.builder.GroupBuilder
- name - Variable in class com.github.rvesse.airline.examples.simple.Simple
-
Here we declare an option that requires a value by using the
arity
field of theOption
annotation - name - Variable in class com.github.rvesse.airline.examples.userguide.restrictions.OptionalOption
- name - Variable in class com.github.rvesse.airline.examples.userguide.restrictions.RequiredOption
- name - Variable in enum com.github.rvesse.airline.io.colors.BasicColor
- name - Variable in enum com.github.rvesse.airline.io.decorations.BasicDecoration
- name - Variable in class com.github.rvesse.airline.model.AliasMetadata
- name - Variable in class com.github.rvesse.airline.model.CommandGroupMetadata
- name - Variable in class com.github.rvesse.airline.model.CommandMetadata
- name - Variable in class com.github.rvesse.airline.model.GlobalMetadata
- name - Variable in class com.github.rvesse.airline.utils.predicates.parser.AliasFinder
- name - Variable in class com.github.rvesse.airline.utils.predicates.parser.CommandFinder
- name - Variable in class com.github.rvesse.airline.utils.predicates.parser.GroupFinder
- name - Variable in class com.github.rvesse.airline.utils.predicates.parser.OptionFinder
- name() - Method in annotation type com.github.rvesse.airline.annotations.Alias
-
Name of the alias
- name() - Method in annotation type com.github.rvesse.airline.annotations.Cli
-
Sets the name of the CLI i.e.
- name() - Method in annotation type com.github.rvesse.airline.annotations.Command
-
Name of the command
- name() - Method in annotation type com.github.rvesse.airline.annotations.Group
-
Name of the group.
- name() - Method in annotation type com.github.rvesse.airline.annotations.Option
-
An array of allowed command line parameters e.g.
- NAME_VALUE_SEPARATOR - Static variable in class com.github.rvesse.airline.examples.userguide.parser.options.JdbcStyleOptionParser
- names - Variable in class com.github.rvesse.airline.restrictions.options.RequiredOnlyIfRestriction
- names() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.RequiredOnlyIf
-
The name(s) of the other option(s) that must be present for this to be a required option
- Negative - Annotation Type in com.github.rvesse.airline.annotations.restrictions.ranges
-
Annotation that marks values as being restricted to being a negative value
- newCollection(Class<?>) - Static method in class com.github.rvesse.airline.Accessor
- newFreeFormPrompt(String) - Static method in class com.github.rvesse.airline.prompts.Prompts
-
Creates a free form question prompt
- newIndentedPrinter(int) - Method in class com.github.rvesse.airline.io.printers.UsagePrinter
- newInstance() - Static method in class com.github.rvesse.airline.parser.ParseState
- newline - Variable in class com.github.rvesse.airline.io.printers.TroffPrinter
- newline() - Method in class com.github.rvesse.airline.io.printers.UsagePrinter
- NEWLINE - Static variable in class com.github.rvesse.airline.help.cli.bash.BashCompletionGenerator
- NEWLINE - Static variable in class com.github.rvesse.airline.help.html.HtmlCommandUsageGenerator
-
Constant for a new line (using a
<br>
) - newOptionsPrompt(String, TOption...) - Static method in class com.github.rvesse.airline.prompts.Prompts
-
Creates a new list prompt
- newPrinterWithHangingIndent(int) - Method in class com.github.rvesse.airline.io.printers.UsagePrinter
- newYesNoAbortPrompt(String) - Static method in class com.github.rvesse.airline.prompts.Prompts
-
Creates a Yes/No/Abort prompt
- newYesNoCancelPrompt(String) - Static method in class com.github.rvesse.airline.prompts.Prompts
-
Creates a new Yes/No/Cancel prompt
- newYesNoPrompt(String) - Static method in class com.github.rvesse.airline.prompts.Prompts
-
Creates a Yes/No prompt
- nextBulletedListItem() - Method in class com.github.rvesse.airline.io.printers.TroffPrinter
- NextDay - com.github.rvesse.airline.examples.sendit.PostalService
- NextDayAM - com.github.rvesse.airline.examples.sendit.PostalService
- nextNumberedListItem() - Method in class com.github.rvesse.airline.io.printers.TroffPrinter
- nextPlainListItem() - Method in class com.github.rvesse.airline.io.printers.TroffPrinter
- nextSection(String) - Method in class com.github.rvesse.airline.io.printers.TroffPrinter
- nextTitledListItem() - Method in class com.github.rvesse.airline.io.printers.TroffPrinter
-
Moves to the next titled list item without providing a title.
- nextTitledListItem(String) - Method in class com.github.rvesse.airline.io.printers.TroffPrinter
- NO_DEFAULT() - Constructor for class com.github.rvesse.airline.annotations.Cli.NO_DEFAULT
- NO_DEFAULT() - Constructor for class com.github.rvesse.airline.annotations.Group.NO_DEFAULT
- NoMissingOptionValues - Annotation Type in com.github.rvesse.airline.annotations.restrictions.global
-
Specifies that a CLI does not permit options to be specified without their values
- NoMissingOptionValuesRestriction - Class in com.github.rvesse.airline.restrictions.global
- NoMissingOptionValuesRestriction() - Constructor for class com.github.rvesse.airline.restrictions.global.NoMissingOptionValuesRestriction
- None - Class in com.github.rvesse.airline.restrictions
-
A restriction which doesn't actually impose any restrictions
- None() - Constructor for class com.github.rvesse.airline.restrictions.None
- NONE - com.github.rvesse.airline.help.cli.bash.CompletionBehaviour
-
None, either this is a flag option i.e.
- NONE_PRINTABLE - com.github.rvesse.airline.help.sections.HelpFormat
-
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
- NoOptionLikeValues - Annotation Type in com.github.rvesse.airline.annotations.restrictions
-
An annotation that marks that values provided for options/arguments MUST NOT look like possible options.
- NoOptionLikeValuesRestriction - Class in com.github.rvesse.airline.restrictions.common
-
A restriction that enforces that values CANNOT look like options
- NoOptionLikeValuesRestriction(String[]) - Constructor for class com.github.rvesse.airline.restrictions.common.NoOptionLikeValuesRestriction
- NORMAL_INTENSITY - Static variable in class com.github.rvesse.airline.io.AnsiControlCodes
- NotBlank - Annotation Type in com.github.rvesse.airline.annotations.restrictions
-
An annotation that marks that an options values must not be blank i.e.
- NotBlankRestriction - Class in com.github.rvesse.airline.restrictions.common
- NotBlankRestriction() - Constructor for class com.github.rvesse.airline.restrictions.common.NotBlankRestriction
- NotEmpty - Annotation Type in com.github.rvesse.airline.annotations.restrictions
-
An annotation that marks an options value must not be empty
- NotEmptyRestriction - Class in com.github.rvesse.airline.restrictions.common
- NotEmptyRestriction() - Constructor for class com.github.rvesse.airline.restrictions.common.NotEmptyRestriction
- notExecutable(String, String) - Method in class com.github.rvesse.airline.restrictions.common.PathRestriction
- notInList() - Method in class com.github.rvesse.airline.io.printers.TroffPrinter
- notReadable(String, String) - Method in class com.github.rvesse.airline.restrictions.common.PathRestriction
- notWritable(String, String) - Method in class com.github.rvesse.airline.restrictions.common.PathRestriction
- NoUnexpectedArguments - Annotation Type in com.github.rvesse.airline.annotations.restrictions.global
-
Marks that a CLI does not permit any command line arguments that aren't recognised as either options or arguments.
- NoUnexpectedArgumentsRestriction - Class in com.github.rvesse.airline.restrictions.global
- NoUnexpectedArgumentsRestriction() - Constructor for class com.github.rvesse.airline.restrictions.global.NoUnexpectedArgumentsRestriction
- noValueForOption(ParseState<T>, OptionMetadata) - Method in class com.github.rvesse.airline.parser.options.AbstractOptionParser
-
Reports that no/insufficient values were provided for an option
- number - Variable in class com.github.rvesse.airline.examples.simple.Simple
-
As we declare this field to be of type
int
Airline will ensure that the value passed to this option can be converted to an integer and throws an error if this is not possible - NUMBERED - com.github.rvesse.airline.io.printers.TroffPrinter.ListType
- numContentBlocks() - Method in class com.github.rvesse.airline.examples.userguide.restrictions.custom.MultipleOfRestriction
- numContentBlocks() - Method in class com.github.rvesse.airline.help.sections.common.BasicHint
- numContentBlocks() - Method in class com.github.rvesse.airline.help.sections.common.VersionSection
- numContentBlocks() - Method in interface com.github.rvesse.airline.help.sections.HelpHint
-
Gets the number of content blocks provided
- numContentBlocks() - Method in class com.github.rvesse.airline.restrictions.common.AbstractAllowedValuesRestriction
- numContentBlocks() - Method in class com.github.rvesse.airline.restrictions.common.EndsWithRestriction
- numContentBlocks() - Method in class com.github.rvesse.airline.restrictions.common.LengthRestriction
- numContentBlocks() - Method in class com.github.rvesse.airline.restrictions.common.NoOptionLikeValuesRestriction
- numContentBlocks() - Method in class com.github.rvesse.airline.restrictions.common.NotBlankRestriction
- numContentBlocks() - Method in class com.github.rvesse.airline.restrictions.common.NotEmptyRestriction
- numContentBlocks() - Method in class com.github.rvesse.airline.restrictions.common.OccurrencesRestriction
- numContentBlocks() - Method in class com.github.rvesse.airline.restrictions.common.PartialRestriction
- numContentBlocks() - Method in class com.github.rvesse.airline.restrictions.common.PathRestriction
- numContentBlocks() - Method in class com.github.rvesse.airline.restrictions.common.PatternRestriction
- numContentBlocks() - Method in class com.github.rvesse.airline.restrictions.common.PortRestriction
- numContentBlocks() - Method in class com.github.rvesse.airline.restrictions.common.PositiveNegativeRestriction
- numContentBlocks() - Method in class com.github.rvesse.airline.restrictions.common.RangeRestriction
- numContentBlocks() - Method in class com.github.rvesse.airline.restrictions.common.StartsWithRestriction
- numContentBlocks() - Method in class com.github.rvesse.airline.restrictions.options.MutuallyExclusiveRestriction
- numContentBlocks() - Method in class com.github.rvesse.airline.restrictions.options.RequiredOnlyIfRestriction
- numContentBlocks() - Method in class com.github.rvesse.airline.restrictions.options.RequiredUnlessEnvironmentRestriction
- numContentBlocks() - Method in class com.github.rvesse.airline.restrictions.options.RequireFromRestriction
- NumericCandidate - Class in com.github.rvesse.airline.types.numerics
- NumericCandidate(String) - Constructor for class com.github.rvesse.airline.types.numerics.NumericCandidate
- NumericCandidate(String, String, String, String) - Constructor for class com.github.rvesse.airline.types.numerics.NumericCandidate
- numericConverter - Variable in class com.github.rvesse.airline.types.DefaultTypeConverter
- numericTypeConverter - Variable in class com.github.rvesse.airline.builder.ParserBuilder
- numericTypeConverter() - Method in annotation type com.github.rvesse.airline.annotations.Parser
-
Sets the numeric type converter to use, this is used in conjunction with the value of the
Parser.typeConverter()
, if that class does not respectNumericTypeConverter
instances then this field has no effect - NumericTypeConverter - Interface in com.github.rvesse.airline.types.numerics
-
Interfaces for numeric type converters
O
- occurrences - Variable in class com.github.rvesse.airline.restrictions.common.OccurrencesRestriction
- occurrences() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.MaxOccurrences
-
The maximum number of occurrences for this option
- occurrences() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.MinOccurrences
-
The minimum number of occurrences for this option
- OccurrencesRestriction - Class in com.github.rvesse.airline.restrictions.common
- OccurrencesRestriction(int, boolean) - Constructor for class com.github.rvesse.airline.restrictions.common.OccurrencesRestriction
- OccurrencesRestrictionFactory - Class in com.github.rvesse.airline.restrictions.factories
-
An annotation used to mark that an option must occur at most once
- OccurrencesRestrictionFactory() - Constructor for class com.github.rvesse.airline.restrictions.factories.OccurrencesRestrictionFactory
- Octal - Class in com.github.rvesse.airline.types.numerics.bases
-
A type converter that supports octal numbers
- Octal() - Constructor for class com.github.rvesse.airline.types.numerics.bases.Octal
- offendingAlias - Variable in exception com.github.rvesse.airline.parser.errors.ParseAliasCircularReferenceException
- Once - Annotation Type in com.github.rvesse.airline.annotations.restrictions
-
An annotation that marks that an option may occur at most once
- open(String, String) - Method in class com.github.rvesse.airline.parser.resources.ClasspathLocator
- open(String, String) - Method in class com.github.rvesse.airline.parser.resources.FileLocator
- open(String, String) - Method in class com.github.rvesse.airline.parser.resources.jpms.JpmsResourceLocator
- open(String, String) - Method in class com.github.rvesse.airline.parser.resources.ModulePathLocator
- open(String, String) - Method in interface com.github.rvesse.airline.parser.resources.ResourceLocator
-
Opens a search location, potentially applying some resolution rules to that location
- openOutputStream() - Method in class com.github.rvesse.airline.examples.io.ColorDemo
- openOutputStream() - Method in class com.github.rvesse.airline.examples.io.Colors256
- openOutputStream() - Method in class com.github.rvesse.airline.examples.io.ColorsBasic
- openOutputStream() - Method in class com.github.rvesse.airline.examples.io.ColorsTrue
- openResource(ResourceLocator[], String) - Method in class com.github.rvesse.airline.help.external.factories.ExternalHelpFactory
-
Opens the specified resource using the first resource locator that is able to open it
- opt - Variable in class com.github.rvesse.airline.utils.predicates.parser.ParsedOptionFinder
- Option - Annotation Type in com.github.rvesse.airline.annotations
-
Annotation to mark a field as an option
- OPTION - com.github.rvesse.airline.Context
- OPTION_RESTRICTION_FACTORIES - Static variable in class com.github.rvesse.airline.restrictions.factories.RestrictionRegistry
- OPTION_SEPARATOR - Static variable in class com.github.rvesse.airline.examples.userguide.parser.options.JdbcStyleOptionParser
- optional - Variable in class com.github.rvesse.airline.examples.simple.Required
- OptionalOption - Class in com.github.rvesse.airline.examples.userguide.restrictions
- OptionalOption() - Constructor for class com.github.rvesse.airline.examples.userguide.restrictions.OptionalOption
- optionComparator - Variable in class com.github.rvesse.airline.help.common.AbstractUsageGenerator
- OptionFinder - Class in com.github.rvesse.airline.utils.predicates.parser
- OptionFinder(String) - Constructor for class com.github.rvesse.airline.utils.predicates.parser.OptionFinder
- optionMatcher - Variable in class com.github.rvesse.airline.prompts.builders.PromptBuilder
- optionMatcher - Variable in class com.github.rvesse.airline.prompts.Prompt
- OptionMetadata - Class in com.github.rvesse.airline.model
- OptionMetadata(OptionType, Iterable<String>, Iterable<String>, String, int, boolean, boolean, boolean, Iterable<OptionRestriction>, TypeConverterProvider, Iterable<Field>) - Constructor for class com.github.rvesse.airline.model.OptionMetadata
- OptionMetadata(Iterable<OptionMetadata>) - Constructor for class com.github.rvesse.airline.model.OptionMetadata
- optionName - Variable in exception com.github.rvesse.airline.parser.errors.ParseOptionIllegalValueException
- OptionParser<T> - Interface in com.github.rvesse.airline.parser.options
-
Interface for option parsers
- optionParsers - Variable in class com.github.rvesse.airline.builder.ParserBuilder
- optionParsers - Variable in class com.github.rvesse.airline.model.ParserMetadata
- optionParsers() - Method in annotation type com.github.rvesse.airline.annotations.Parser
-
Sets the option parser classes to be used
- optionPrefixes() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.NoOptionLikeValues
-
Indicates the prefixes that will be used to detect values that look like options.
- optionRestriction - Variable in class com.github.rvesse.airline.restrictions.common.PartialRestriction
- OptionRestriction - Interface in com.github.rvesse.airline.restrictions
-
Represents restrictions on options
- OptionRestrictionFactory - Interface in com.github.rvesse.airline.restrictions.factories
-
Interface for option restriction factories
- options - Variable in class com.github.rvesse.airline.model.CommandGroupMetadata
- options - Variable in class com.github.rvesse.airline.model.GlobalMetadata
- options - Variable in class com.github.rvesse.airline.model.OptionMetadata
- options - Variable in exception com.github.rvesse.airline.parser.errors.ParseOptionGroupException
- options - Variable in class com.github.rvesse.airline.prompts.builders.PromptBuilder
- options - Variable in class com.github.rvesse.airline.prompts.Prompt
- optionsCount - Variable in class com.github.rvesse.airline.parser.ParseState
- optionSeparators - Variable in class com.github.rvesse.airline.builder.CliBuilder
- optionTitle - Variable in exception com.github.rvesse.airline.parser.errors.ParseArgumentsIllegalValueException
- optionTitle - Variable in exception com.github.rvesse.airline.parser.errors.ParseOptionConversionException
- optionTitle - Variable in exception com.github.rvesse.airline.parser.errors.ParseOptionIllegalValueException
- optionTitle - Variable in exception com.github.rvesse.airline.parser.errors.ParseOptionMissingException
- optionTitle - Variable in exception com.github.rvesse.airline.parser.errors.ParseOptionMissingValueException
- optionType - Variable in class com.github.rvesse.airline.model.OptionMetadata
- optionType - Variable in class com.github.rvesse.airline.prompts.matchers.ValueMatcher
- OptionType - Enum in com.github.rvesse.airline.annotations
- OptionType() - Constructor for enum com.github.rvesse.airline.annotations.OptionType
- order - Variable in class com.github.rvesse.airline.help.sections.common.BasicSection
- ORDER_COPYRIGHT - Static variable in class com.github.rvesse.airline.help.sections.common.CommonSections
-
Constants defining the relative order of some commonly used help sections
- ORDER_DISCUSSION - Static variable in class com.github.rvesse.airline.help.sections.common.CommonSections
-
Constants defining the relative order of some commonly used help sections
- ORDER_EXAMPLES - Static variable in class com.github.rvesse.airline.help.sections.common.CommonSections
-
Constants defining the relative order of some commonly used help sections
- ORDER_EXIT_CODES - Static variable in class com.github.rvesse.airline.help.sections.common.CommonSections
-
Constants defining the relative order of some commonly used help sections
- ORDER_LICENSE - Static variable in class com.github.rvesse.airline.help.sections.common.CommonSections
-
Constants defining the relative order of some commonly used help sections
- ORDER_SEE_ALSO - Static variable in class com.github.rvesse.airline.help.sections.common.CommonSections
-
Constants defining the relative order of some commonly used help sections
- ORDER_VERSION - Static variable in class com.github.rvesse.airline.help.sections.common.CommonSections
-
Constants defining the relative order of some commonly used help sections
- origValue - Variable in class com.github.rvesse.airline.types.numerics.NumericCandidate
- OS_ALLOCATED - com.github.rvesse.airline.annotations.restrictions.PortType
-
Port
0
i.e. - out - Variable in class com.github.rvesse.airline.io.printers.UsagePrinter
- output - Variable in class com.github.rvesse.airline.io.output.OutputStreamControlTracker
- output() - Static method in class com.github.rvesse.airline.Channels
-
Returns output channel.
- outputAdditionalCss(Writer) - Method in class com.github.rvesse.airline.help.html.HtmlCommandUsageGenerator
-
Outputs additional CSS directly
- outputArguments(TroffPrinter, ArgumentsMetadata, boolean, ParserMetadata<T>) - Method in class com.github.rvesse.airline.help.man.ManUsageHelper
- outputArguments(UsagePrinter, ArgumentsMetadata, ParserMetadata<T>) - Method in class com.github.rvesse.airline.help.cli.CliUsageHelper
- outputArguments(UsagePrinter, ArgumentsMetadata, ParserMetadata<T>) - Method in class com.github.rvesse.airline.help.markdown.MarkdownUsageHelper
- outputArgumentsRestriction(TroffPrinter, ArgumentsMetadata, ArgumentsRestriction, HelpHint) - Method in class com.github.rvesse.airline.help.man.ManUsageHelper
-
Outputs documentation about a restriction on an option
- outputArgumentsRestriction(UsagePrinter, ArgumentsMetadata, ArgumentsRestriction, HelpHint) - Method in class com.github.rvesse.airline.help.cli.CliUsageHelper
-
Outputs documentation about a restriction on an option
- outputArgumentsRestriction(UsagePrinter, ArgumentsMetadata, ArgumentsRestriction, HelpHint) - Method in class com.github.rvesse.airline.help.markdown.MarkdownUsageHelper
-
Outputs documentation about a restriction on an option
- outputArgumentsSynopsis(TroffPrinter, ArgumentsMetadata) - Method in class com.github.rvesse.airline.help.man.ManUsageHelper
- outputArgumentsSynopsis(UsagePrinter, ArgumentsMetadata) - Method in class com.github.rvesse.airline.help.markdown.MarkdownUsageHelper
- outputArgumentsTitle(TroffPrinter, ArgumentsMetadata) - Method in class com.github.rvesse.airline.help.man.ManUsageHelper
- outputArgumentsTitle(UsagePrinter, ArgumentsMetadata) - Method in class com.github.rvesse.airline.help.markdown.MarkdownUsageHelper
- outputCommandDescription(UsagePrinter, CommandGroupMetadata, CommandMetadata) - Method in class com.github.rvesse.airline.help.cli.CliGlobalUsageGenerator
-
Outputs the description for a command
- outputCommandDescription(UsagePrinter, CommandGroupMetadata, CommandMetadata) - Method in class com.github.rvesse.airline.help.markdown.MarkdownGlobalUsageGenerator
-
Outputs the description for a command
- outputCommandList(TroffPrinter, GlobalMetadata<T>) - Method in class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator
-
Outputs a documentation section that lists the available commands
- outputCommandList(UsagePrinter, GlobalMetadata<T>) - Method in class com.github.rvesse.airline.help.cli.CliGlobalUsageGenerator
-
Outputs a documentation section listing the commands
- outputCommandList(UsagePrinter, GlobalMetadata<T>) - Method in class com.github.rvesse.airline.help.cli.CliGlobalUsageSummaryGenerator
-
Outputs a documentation section listing the common commands and groups
- outputCommandList(UsagePrinter, GlobalMetadata<T>) - Method in class com.github.rvesse.airline.help.markdown.MarkdownGlobalUsageGenerator
-
Outputs a documentation section listing the commands
- outputCommandUsages(UsagePrinter, GlobalMetadata<T>) - Method in class com.github.rvesse.airline.help.markdown.MarkdownGlobalUsageGenerator
-
Outputs the command usages for all groups
- outputCommandUsages(OutputStream, TroffPrinter, GlobalMetadata<T>) - Method in class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator
-
Outputs the command usages for all groups
- outputCommandUsages(OutputStream, TroffPrinter, GlobalMetadata<T>) - Method in class com.github.rvesse.airline.help.man.ManMultiPageGlobalUsageGenerator
- outputDefaultGroupCommandUsages(UsagePrinter, GlobalMetadata<T>) - Method in class com.github.rvesse.airline.help.markdown.MarkdownGlobalUsageGenerator
-
Outputs the command usages for the commands in the default group
- outputDefaultGroupCommandUsages(UsagePrinter, GlobalMetadata<T>) - Method in class com.github.rvesse.airline.help.markdown.MarkdownMultiPageGlobalUsageGenerator
- outputDefaultGroupCommandUsages(OutputStream, TroffPrinter, GlobalMetadata<T>) - Method in class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator
-
Outputs the command usages for the commands in the default group
- outputDefaultGroupCommandUsages(OutputStream, TroffPrinter, GlobalMetadata<T>) - Method in class com.github.rvesse.airline.help.man.ManMultiPageGlobalUsageGenerator
- outputDescription(UsagePrinter, GlobalMetadata<T>) - Method in class com.github.rvesse.airline.help.cli.CliGlobalUsageGenerator
-
Outputs a documentation section with a description of the CLI
- outputDescription(UsagePrinter, GlobalMetadata<T>) - Method in class com.github.rvesse.airline.help.markdown.MarkdownGlobalUsageGenerator
-
Outputs a documentation section with a description of the CLI
- outputDescription(UsagePrinter, GlobalMetadata<T>, CommandGroupMetadata[]) - Method in class com.github.rvesse.airline.help.cli.CliCommandGroupUsageGenerator
-
Outputs a description of the group
- outputDescription(UsagePrinter, String, String[], String, CommandMetadata) - Method in class com.github.rvesse.airline.help.cli.CliCommandUsageGenerator
-
Outputs a documentation section describing the command
- outputDescription(UsagePrinter, String, String[], String, CommandMetadata) - Method in class com.github.rvesse.airline.help.markdown.MarkdownCommandUsageGenerator
-
Outputs a documentation section describing the command
- outputDescription(Writer, String, String[], CommandMetadata) - Method in class com.github.rvesse.airline.help.html.HtmlCommandUsageGenerator
-
Outputs a documentation section with the name and description of the command
- outputFooter(UsagePrinter, GlobalMetadata<T>) - Method in class com.github.rvesse.airline.help.cli.CliGlobalUsageSummaryGenerator
-
Outputs a documentation section detailing how to get more help
- outputGroupCommandsList(TroffPrinter, GlobalMetadata<T>, List<CommandGroupMetadata>) - Method in class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator
- outputGroupCommandsList(UsagePrinter, GlobalMetadata<T>, List<CommandGroupMetadata>) - Method in class com.github.rvesse.airline.help.cli.CliGlobalUsageGenerator
- outputGroupCommandsList(UsagePrinter, GlobalMetadata<T>, List<CommandGroupMetadata>) - Method in class com.github.rvesse.airline.help.markdown.MarkdownGlobalUsageGenerator
- outputGroupCommandUsages(UsagePrinter, GlobalMetadata<T>, List<CommandGroupMetadata>) - Method in class com.github.rvesse.airline.help.markdown.MarkdownGlobalUsageGenerator
-
Outputs the command usages for the commands in the given group
- outputGroupCommandUsages(UsagePrinter, GlobalMetadata<T>, List<CommandGroupMetadata>) - Method in class com.github.rvesse.airline.help.markdown.MarkdownMultiPageGlobalUsageGenerator
- outputGroupCommandUsages(OutputStream, TroffPrinter, GlobalMetadata<T>, List<CommandGroupMetadata>) - Method in class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator
-
Outputs the command usages for the commands in the given group
- outputGroupCommandUsages(OutputStream, TroffPrinter, GlobalMetadata<T>, List<CommandGroupMetadata>) - Method in class com.github.rvesse.airline.help.man.ManMultiPageGlobalUsageGenerator
- outputGroupList(TroffPrinter, GlobalMetadata<T>) - Method in class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator
-
Outputs a documentation section that lists the available groups and the commands they contain
- outputHelpHint(Writer, HelpHint) - Method in class com.github.rvesse.airline.help.html.HtmlCommandUsageGenerator
-
Outputs a help hint
- outputHelpSection(TroffPrinter, HelpSection) - Method in class com.github.rvesse.airline.help.man.ManUsageHelper
-
Outputs a help section
- outputHelpSection(UsagePrinter, HelpSection) - Method in class com.github.rvesse.airline.help.cli.CliUsageHelper
-
Outputs a help section
- outputHelpSection(UsagePrinter, HelpSection) - Method in class com.github.rvesse.airline.help.markdown.MarkdownUsageHelper
-
Outputs a help section
- outputHelpSection(Writer, HelpSection) - Method in class com.github.rvesse.airline.help.html.HtmlCommandUsageGenerator
-
Outputs a help section
- outputHint(TroffPrinter, HelpHint) - Method in class com.github.rvesse.airline.help.man.ManUsageHelper
- outputHint(UsagePrinter, HelpHint, boolean) - Method in class com.github.rvesse.airline.help.cli.CliUsageHelper
- outputHint(UsagePrinter, HelpHint, boolean) - Method in class com.github.rvesse.airline.help.markdown.MarkdownUsageHelper
- outputHtmlHeader(Writer) - Method in class com.github.rvesse.airline.help.html.HtmlCommandUsageGenerator
-
Outputs the HTML header for the page
- outputOptionRestriction(TroffPrinter, OptionMetadata, OptionRestriction, HelpHint) - Method in class com.github.rvesse.airline.help.man.ManUsageHelper
-
Outputs documentation about a restriction on an option
- outputOptionRestriction(UsagePrinter, OptionMetadata, OptionRestriction, HelpHint) - Method in class com.github.rvesse.airline.help.cli.CliUsageHelper
-
Outputs documentation about a restriction on an option
- outputOptionRestriction(UsagePrinter, OptionMetadata, OptionRestriction, HelpHint) - Method in class com.github.rvesse.airline.help.markdown.MarkdownUsageHelper
-
Outputs documentation about a restriction on an option
- outputOptionRestriction(Writer, OptionMetadata, OptionRestriction, HelpHint) - Method in class com.github.rvesse.airline.help.html.HtmlCommandUsageGenerator
-
Outputs a documentation section detailing an allowed value for an option
- outputOptions(TroffPrinter, CommandMetadata, List<OptionMetadata>, ParserMetadata<T>) - Method in class com.github.rvesse.airline.help.man.ManCommandUsageGenerator
-
Outputs a documentation section detailing the options and their usages
- outputOptions(TroffPrinter, List<OptionMetadata>, boolean) - Method in class com.github.rvesse.airline.help.man.ManUsageHelper
- outputOptions(UsagePrinter, GlobalMetadata<T>, CommandGroupMetadata[]) - Method in class com.github.rvesse.airline.help.cli.CliCommandGroupUsageGenerator
-
Outputs a documentation section detailing the available options and their usages
- outputOptions(UsagePrinter, List<OptionMetadata>) - Method in class com.github.rvesse.airline.help.cli.CliUsageHelper
- outputOptions(UsagePrinter, List<OptionMetadata>) - Method in class com.github.rvesse.airline.help.markdown.MarkdownUsageHelper
- outputOptions(Writer, List<OptionMetadata>, ArgumentsMetadata, ParserMetadata<T>) - Method in class com.github.rvesse.airline.help.html.HtmlCommandUsageGenerator
-
Outputs a documentation section detailing the options
- outputOptionsAndArguments(UsagePrinter, CommandMetadata, List<OptionMetadata>, ArgumentsMetadata, ParserMetadata<T>) - Method in class com.github.rvesse.airline.help.cli.CliCommandUsageGenerator
-
Outputs a documentation section detailing options and their usages
- outputOptionsAndArguments(UsagePrinter, CommandMetadata, List<OptionMetadata>, ArgumentsMetadata, ParserMetadata<T>) - Method in class com.github.rvesse.airline.help.markdown.MarkdownCommandUsageGenerator
-
Outputs a documentation section detailing options and their usages
- outputOptionsSynopsis(TroffPrinter, List<OptionMetadata>) - Method in class com.github.rvesse.airline.help.man.ManUsageHelper
- outputOptionsSynopsis(UsagePrinter, List<OptionMetadata>) - Method in class com.github.rvesse.airline.help.markdown.MarkdownUsageHelper
- outputOptionSynopsis(TroffPrinter, OptionMetadata) - Method in class com.github.rvesse.airline.help.man.ManUsageHelper
- outputOptionSynopsis(UsagePrinter, OptionMetadata) - Method in class com.github.rvesse.airline.help.markdown.MarkdownUsageHelper
- outputOptionTitle(TroffPrinter, OptionMetadata) - Method in class com.github.rvesse.airline.help.man.ManUsageHelper
- outputOptionTitle(UsagePrinter, OptionMetadata) - Method in class com.github.rvesse.airline.help.markdown.MarkdownUsageHelper
- outputPageHeader(Writer, String, String[], CommandMetadata) - Method in class com.github.rvesse.airline.help.html.HtmlCommandUsageGenerator
-
Outputs a page header
- outputReferenceToSuite(TroffPrinter, GlobalMetadata<T>) - Method in class com.github.rvesse.airline.help.man.ManMultiPageGlobalUsageGenerator
- outputReferenceToSuite(OutputStream, GlobalMetadata<T>) - Method in class com.github.rvesse.airline.help.markdown.MarkdownMultiPageGlobalUsageGenerator
- OutputStreamControlTracker<T> - Class in com.github.rvesse.airline.io.output
- OutputStreamControlTracker(OutputStream, ControlCodeSource<T>) - Constructor for class com.github.rvesse.airline.io.output.OutputStreamControlTracker
- OutputStreamControlTracker(OutputStream, Charset, ControlCodeSource<T>) - Constructor for class com.github.rvesse.airline.io.output.OutputStreamControlTracker
- outputStylesheets(Writer) - Method in class com.github.rvesse.airline.help.html.HtmlCommandUsageGenerator
-
Outputs the style sheet declarations
- outputSynopsis(TroffPrinter, GlobalMetadata<T>) - Method in class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator
-
Outputs a documentation section with a synopsis of how to use the CLI
- outputSynopsis(TroffPrinter, String, String[], String, CommandMetadata) - Method in class com.github.rvesse.airline.help.man.ManCommandUsageGenerator
-
Outputs a synopsis section for the documentation showing how to use a command
- outputSynopsis(UsagePrinter, GlobalMetadata<T>) - Method in class com.github.rvesse.airline.help.cli.CliGlobalUsageGenerator
-
Outputs a documentation section with a synopsis of CLI usage
- outputSynopsis(UsagePrinter, GlobalMetadata<T>) - Method in class com.github.rvesse.airline.help.cli.CliGlobalUsageSummaryGenerator
-
Outputs a documentation section with a brief synopsis of usage
- outputSynopsis(UsagePrinter, GlobalMetadata<T>) - Method in class com.github.rvesse.airline.help.markdown.MarkdownGlobalUsageGenerator
-
Outputs a documentation section with a synopsis of CLI usage
- outputSynopsis(UsagePrinter, GlobalMetadata<T>, CommandGroupMetadata[]) - Method in class com.github.rvesse.airline.help.cli.CliCommandGroupUsageGenerator
-
Outputs a documentation section detailing a usage synopsis
- outputSynopsis(UsagePrinter, String, String[], String, CommandMetadata) - Method in class com.github.rvesse.airline.help.cli.CliCommandUsageGenerator
-
Outputs a documentation section with a synopsis of command usage
- outputSynopsis(UsagePrinter, String, String[], String, CommandMetadata) - Method in class com.github.rvesse.airline.help.markdown.MarkdownCommandUsageGenerator
-
Outputs a documentation section with a synopsis of command usage
- outputSynopsis(Writer, String, String[], CommandMetadata) - Method in class com.github.rvesse.airline.help.html.HtmlCommandUsageGenerator
-
Outputs a documentation section with a synopsis of the command
- outputTitle(TroffPrinter, String, String[], String, CommandMetadata) - Method in class com.github.rvesse.airline.help.man.ManCommandUsageGenerator
-
Outputs a title section for the document
- outputTitle(GlobalMetadata<T>, TroffPrinter) - Method in class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator
-
Outputs the title section for the documentation
- outputUserAliases(UsagePrinter, GlobalMetadata<T>, UserAliasesSource<T>) - Method in class com.github.rvesse.airline.help.cli.CliGlobalUsageGenerator
- outputUserAliases(UsagePrinter, GlobalMetadata<T>, UserAliasesSource<T>) - Method in class com.github.rvesse.airline.help.markdown.MarkdownGlobalUsageGenerator
- override() - Method in annotation type com.github.rvesse.airline.annotations.Option
-
If true this parameter can override parameters of the same name (set via the
Option.name()
property) declared by parent classes assuming the option definitions are compatible. - override(Set<String>, OptionMetadata, OptionMetadata) - Static method in class com.github.rvesse.airline.model.OptionMetadata
-
Tries to merge the option metadata together such that the child metadata takes precedence.
- overrideOptionSet(List<OptionMetadata>) - Static method in class com.github.rvesse.airline.model.MetadataLoader
- overrides - Variable in class com.github.rvesse.airline.model.OptionMetadata
P
- Package - Class in com.github.rvesse.airline.examples.sendit
- Package() - Constructor for class com.github.rvesse.airline.examples.sendit.Package
- paragraphs() - Method in annotation type com.github.rvesse.airline.annotations.help.Discussion
-
An array of paragraphs of text that provides an extended discussion on the behaviour of the command.
- paragraphs() - Method in annotation type com.github.rvesse.airline.annotations.help.License
-
Gets/Sets text describing the license that applies
- paragraphs() - Method in annotation type com.github.rvesse.airline.annotations.help.ProseSection
-
An array of paragraphs of text that provides prose for the help section
- ParagraphsParser - Interface in com.github.rvesse.airline.help.external.parsers
-
Parser that translates input into a series of paragraphs
- PARAM_SEPARATOR - Static variable in class com.github.rvesse.airline.io.AnsiControlCodes
-
Character used to separate parameters in ANSI escape sequences
- parent - Variable in class com.github.rvesse.airline.builder.AbstractChildBuilder
- parent - Variable in class com.github.rvesse.airline.examples.inheritance.BadGrandchild
-
Trying to override the option here will fail because we didn't explicitly state we were overriding
- parent - Variable in class com.github.rvesse.airline.examples.inheritance.GoodGrandchild
-
We can override the definition of an existing option under certain conditions:
arity
,name
andoptionType
are unchanged Type is same or a valid narrowing conversion exists from the inherited option type to the overridden type You explicitly declareoverride
to betrue
and the inherited option does not definesealed
to betrue
- parent - Variable in class com.github.rvesse.airline.examples.inheritance.Parent
- parent() - Method in class com.github.rvesse.airline.builder.AbstractChildBuilder
-
Gets the parent builder
- parent() - Method in class com.github.rvesse.airline.builder.ParserBuilder
-
Gets the parent CLI builder (if any)
- Parent - Class in com.github.rvesse.airline.examples.inheritance
-
We can use standard Java inheritance with commands and the child commands will inherit options defined on their parents
- Parent() - Constructor for class com.github.rvesse.airline.examples.inheritance.Parent
- parentGroup - Variable in class com.github.rvesse.airline.model.CommandGroupMetadata
- parentGroup() - Method in class com.github.rvesse.airline.builder.GroupBuilder
-
Gets the parent group builder which may be
null
if this is a top level group. - parentGroupBuilder - Variable in class com.github.rvesse.airline.builder.GroupBuilder
- parse() - Method in class com.github.rvesse.airline.parser.aliases.AliasArgumentsParser
- parse(GlobalMetadata<T>, Iterable<String>) - Method in class com.github.rvesse.airline.parser.command.CliParser
- parse(GlobalMetadata<T>, Iterable<String>) - Method in class com.github.rvesse.airline.parser.suggester.SuggestionParser
- parse(ParserMetadata<T>, CommandMetadata, Iterable<GlobalRestriction>, Iterable<String>) - Method in class com.github.rvesse.airline.parser.command.SingleCommandParser
- parse(Iterable<String>) - Method in class com.github.rvesse.airline.Cli
-
Parses the arguments to produce a command instance, this may be
null
if the arguments don't identify a command and there was no appropriate default command configured - parse(Iterable<String>) - Method in class com.github.rvesse.airline.SingleCommand
-
Parses the arguments to produce a command instance
- parse(String) - Static method in class com.github.rvesse.airline.parser.aliases.AliasArgumentsParser
- parse(String) - Method in class com.github.rvesse.airline.types.numerics.abbreviated.AbbreviatedNumericTypeConverter
- parse(String) - Method in class com.github.rvesse.airline.types.numerics.ComplexNumericTypeConverter
- parse(String...) - Method in class com.github.rvesse.airline.Cli
-
Parses the arguments to produce a command instance, this may be
null
if the arguments don't identify a command and there was no appropriate default command configured - parse(String...) - Method in class com.github.rvesse.airline.SingleCommand
-
Parses the arguments to produce a command instance
- ParseAliasCircularReferenceException - Exception in com.github.rvesse.airline.parser.errors
-
Exception that occurs when alias chaining is enabled and a circular reference is encountered
- ParseAliasCircularReferenceException(String, Set<String>) - Constructor for exception com.github.rvesse.airline.parser.errors.ParseAliasCircularReferenceException
- parseArg(ParseState<T>, PeekingIterator<String>, ArgumentsMetadata, OptionMetadata) - Method in class com.github.rvesse.airline.parser.AbstractCommandParser
- parseArgs(ParseState<T>, PeekingIterator<String>, ArgumentsMetadata, OptionMetadata) - Method in class com.github.rvesse.airline.parser.AbstractCommandParser
- ParseArgumentsIllegalValueException - Exception in com.github.rvesse.airline.parser.errors
-
Exception thrown when the value for an option is not in a specific set of allowed values
- ParseArgumentsIllegalValueException(String, Object, Set<Object>) - Constructor for exception com.github.rvesse.airline.parser.errors.ParseArgumentsIllegalValueException
- ParseArgumentsMissingException - Exception in com.github.rvesse.airline.parser.errors
-
Exception thrown when required arguments are missing
- ParseArgumentsMissingException(String, List<String>, Object...) - Constructor for exception com.github.rvesse.airline.parser.errors.ParseArgumentsMissingException
- ParseArgumentsMissingException(List<String>) - Constructor for exception com.github.rvesse.airline.parser.errors.ParseArgumentsMissingException
- ParseArgumentsUnexpectedException - Exception in com.github.rvesse.airline.parser.errors
-
Exception that is thrown when a command receives unexpected arguments
- ParseArgumentsUnexpectedException(List<String>) - Constructor for exception com.github.rvesse.airline.parser.errors.ParseArgumentsUnexpectedException
- parseCommand(PeekingIterator<String>, ParseState<T>) - Method in class com.github.rvesse.airline.parser.AbstractCommandParser
- ParseCommandMissingException - Exception in com.github.rvesse.airline.parser.errors
-
Exception that is thrown when no command is specified
- ParseCommandMissingException() - Constructor for exception com.github.rvesse.airline.parser.errors.ParseCommandMissingException
- parseCommandOptionsAndArguments(PeekingIterator<String>, ParseState<T>, CommandMetadata) - Method in class com.github.rvesse.airline.parser.AbstractCommandParser
- ParseCommandUnrecognizedException - Exception in com.github.rvesse.airline.parser.errors
-
Exception that is thrown when an unrecognized command is supplied
- ParseCommandUnrecognizedException(List<String>) - Constructor for exception com.github.rvesse.airline.parser.errors.ParseCommandUnrecognizedException
- parsedArguments - Variable in class com.github.rvesse.airline.parser.ParseState
- ParsedOptionFinder - Class in com.github.rvesse.airline.utils.predicates.parser
- ParsedOptionFinder(OptionMetadata) - Constructor for class com.github.rvesse.airline.utils.predicates.parser.ParsedOptionFinder
- parsedOptions - Variable in class com.github.rvesse.airline.parser.ParseState
- ParseException - Exception in com.github.rvesse.airline.parser.errors
-
Super class of all command line parsing exceptions
- ParseException(Exception, String, Object...) - Constructor for exception com.github.rvesse.airline.parser.errors.ParseException
- ParseException(String, Object...) - Constructor for exception com.github.rvesse.airline.parser.errors.ParseException
- parseGroup(PeekingIterator<String>, ParseState<T>) - Method in class com.github.rvesse.airline.parser.AbstractCommandParser
- ParseInvalidRestrictionException - Exception in com.github.rvesse.airline.parser.errors
-
Parser exception that indicates that a declared restriction was invalid
- ParseInvalidRestrictionException(Exception, String, Object...) - Constructor for exception com.github.rvesse.airline.parser.errors.ParseInvalidRestrictionException
- ParseInvalidRestrictionException(String, Object...) - Constructor for exception com.github.rvesse.airline.parser.errors.ParseInvalidRestrictionException
- ParseOptionConversionException - Exception in com.github.rvesse.airline.parser.errors
-
Exception that is thrown when the argument supplied as the value for an option cannot be converted to the options Java type
- ParseOptionConversionException(String, String, String) - Constructor for exception com.github.rvesse.airline.parser.errors.ParseOptionConversionException
- ParseOptionConversionException(String, String, String, String) - Constructor for exception com.github.rvesse.airline.parser.errors.ParseOptionConversionException
- ParseOptionGroupException - Exception in com.github.rvesse.airline.parser.errors
-
A parser exception that relates to a restriction violated where the violation pertains to some group of options
- ParseOptionGroupException(String, String, Collection<OptionMetadata>, Object...) - Constructor for exception com.github.rvesse.airline.parser.errors.ParseOptionGroupException
- ParseOptionIllegalValueException - Exception in com.github.rvesse.airline.parser.errors
-
Exception thrown when the value for an option is not in a specific set of allowed values
- ParseOptionIllegalValueException(String, String, Object, Set<Object>) - Constructor for exception com.github.rvesse.airline.parser.errors.ParseOptionIllegalValueException
- ParseOptionMissingException - Exception in com.github.rvesse.airline.parser.errors
-
Exception that is thrown when a required option is missing
- ParseOptionMissingException(String) - Constructor for exception com.github.rvesse.airline.parser.errors.ParseOptionMissingException
- ParseOptionMissingException(String, String) - Constructor for exception com.github.rvesse.airline.parser.errors.ParseOptionMissingException
- ParseOptionMissingValueException - Exception in com.github.rvesse.airline.parser.errors
-
Exception that is thrown when an option expects one/more values and no values are supplied
- ParseOptionMissingValueException(String) - Constructor for exception com.github.rvesse.airline.parser.errors.ParseOptionMissingValueException
- ParseOptionMissingValueException(String, String, Object...) - Constructor for exception com.github.rvesse.airline.parser.errors.ParseOptionMissingValueException
- ParseOptionOutOfRangeException - Exception in com.github.rvesse.airline.parser.errors
-
Error that indicates that an options value was outside of an acceptable range
- ParseOptionOutOfRangeException(String, Object, Object, boolean, Object, boolean) - Constructor for exception com.github.rvesse.airline.parser.errors.ParseOptionOutOfRangeException
-
Creates a new out of range exception
- parseOptions(PeekingIterator<String>, ParseState<T>, List<OptionMetadata>) - Method in class com.github.rvesse.airline.examples.userguide.parser.options.JdbcStyleOptionParser
- parseOptions(PeekingIterator<String>, ParseState<T>, List<OptionMetadata>) - Method in class com.github.rvesse.airline.parser.AbstractCommandParser
- parseOptions(PeekingIterator<String>, ParseState<T>, List<OptionMetadata>) - Method in class com.github.rvesse.airline.parser.options.AbstractNameValueOptionParser
- parseOptions(PeekingIterator<String>, ParseState<T>, List<OptionMetadata>) - Method in class com.github.rvesse.airline.parser.options.ClassicGetOptParser
- parseOptions(PeekingIterator<String>, ParseState<T>, List<OptionMetadata>) - Method in class com.github.rvesse.airline.parser.options.ListValueOptionParser
- parseOptions(PeekingIterator<String>, ParseState<T>, List<OptionMetadata>) - Method in class com.github.rvesse.airline.parser.options.MaybeListValueOptionParser
- parseOptions(PeekingIterator<String>, ParseState<T>, List<OptionMetadata>) - Method in class com.github.rvesse.airline.parser.options.MaybePairValueOptionParser
- parseOptions(PeekingIterator<String>, ParseState<T>, List<OptionMetadata>) - Method in interface com.github.rvesse.airline.parser.options.OptionParser
-
Parses one/more options from the token stream
- parseOptions(PeekingIterator<String>, ParseState<T>, List<OptionMetadata>) - Method in class com.github.rvesse.airline.parser.options.StandardOptionParser
- ParseOptionUnexpectedException - Exception in com.github.rvesse.airline.parser.errors
-
Exception thrown if an option is encountered in an unexpected location e.g.
- ParseOptionUnexpectedException(String, Object...) - Constructor for exception com.github.rvesse.airline.parser.errors.ParseOptionUnexpectedException
- parseParagraphs(ResourceLocator[], String, ParagraphsParser) - Method in class com.github.rvesse.airline.help.external.factories.ExternalHelpFactory
-
Parses paragraphs from a resource
- parseParagraphs(String, InputStream) - Method in class com.github.rvesse.airline.help.external.parsers.defaults.DefaultExternalHelpParser
- parseParagraphs(String, InputStream) - Method in interface com.github.rvesse.airline.help.external.parsers.ParagraphsParser
-
Parses input into a series of paragraphs
- parseQuotedArgument(int, List<String>) - Method in class com.github.rvesse.airline.parser.aliases.AliasArgumentsParser
- parser() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalDiscussion
-
The parser to use to translate the source specified by
ExternalDiscussion.source()
into paragraphs - parser() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalExamples
-
The parser to use to translate the source specified by
ExternalExamples.exampleSource()
andExternalExamples.descriptionSource()
into paragraphs - parser() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalExitCodes
-
The parser to use to translate the source specified by
ExternalExitCodes.source()
into paragraphs - parser() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalProse
-
The parser to use to translate the source specified by
ExternalProse.source()
into paragraphs - parser() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalTabularExamples
-
The parser to use to translate the source specified by
ExternalTabularExamples.source()
into tabular data - Parser - Annotation Type in com.github.rvesse.airline.annotations
-
Class annotation used to declaratively specify a parser configuration
- parserBuilder - Variable in class com.github.rvesse.airline.builder.CliBuilder
- ParserBuilder<C> - Class in com.github.rvesse.airline.builder
-
Builder for parser configurations
- ParserBuilder() - Constructor for class com.github.rvesse.airline.builder.ParserBuilder
- ParserBuilder(CliBuilder<C>) - Constructor for class com.github.rvesse.airline.builder.ParserBuilder
- parserConfig - Variable in class com.github.rvesse.airline.model.GlobalMetadata
- parserConfig - Variable in class com.github.rvesse.airline.parser.ParseState
- parserConfig - Variable in class com.github.rvesse.airline.SingleCommand
- parserConfiguration() - Method in annotation type com.github.rvesse.airline.annotations.Cli
-
Sets the parser configuration for the CLI
- ParserErrorHandler - Interface in com.github.rvesse.airline.parser.errors.handlers
-
Interface for parser error handlers
- ParseRestrictionViolatedException - Exception in com.github.rvesse.airline.parser.errors
-
Exception class that indicates that some restriction was violated
- ParseRestrictionViolatedException(Exception, String, Object...) - Constructor for exception com.github.rvesse.airline.parser.errors.ParseRestrictionViolatedException
- ParseRestrictionViolatedException(String, Object...) - Constructor for exception com.github.rvesse.airline.parser.errors.ParseRestrictionViolatedException
- ParseResult<T> - Class in com.github.rvesse.airline.parser
-
Represents parsing results
- ParseResult(ParseState<T>, Collection<ParseException>) - Constructor for class com.github.rvesse.airline.parser.ParseResult
- ParserMetadata<T> - Class in com.github.rvesse.airline.model
-
Represents meta-data about the parser configuration
- ParserMetadata(CommandFactory<T>, Collection<String>, Collection<OptionParser<T>>, TypeConverter, ParserErrorHandler, boolean, boolean, Collection<AliasMetadata>, UserAliasesSource<T>, boolean, boolean, char, String, String) - Constructor for class com.github.rvesse.airline.model.ParserMetadata
- parseRows(String, InputStream) - Method in class com.github.rvesse.airline.help.external.parsers.defaults.DefaultExternalHelpParser
- parseRows(String, InputStream) - Method in interface com.github.rvesse.airline.help.external.parsers.TabularParser
-
Parsers a list of rows from a resource
- ParserUtil - Class in com.github.rvesse.airline.parser
- ParserUtil() - Constructor for class com.github.rvesse.airline.parser.ParserUtil
- ParseState<T> - Class in com.github.rvesse.airline.parser
- ParseState(GlobalMetadata<T>, ParserMetadata<T>, CommandGroupMetadata, CommandMetadata, List<Pair<OptionMetadata, Object>>, Map<OptionMetadata, Integer>, List<Context>, List<Object>, OptionMetadata, List<String>) - Constructor for class com.github.rvesse.airline.parser.ParseState
- parseTabular(ResourceLocator[], String, TabularParser) - Method in class com.github.rvesse.airline.help.external.factories.ExternalHelpFactory
-
Parses tabular data from a resource
- ParseTooManyArgumentsException - Exception in com.github.rvesse.airline.parser.errors
-
Error that is thrown if too many arguments are provided
- ParseTooManyArgumentsException(Exception, String, Object...) - Constructor for exception com.github.rvesse.airline.parser.errors.ParseTooManyArgumentsException
- ParseTooManyArgumentsException(String, Object...) - Constructor for exception com.github.rvesse.airline.parser.errors.ParseTooManyArgumentsException
- parseUnquotedArgument(int, List<String>) - Method in class com.github.rvesse.airline.parser.aliases.AliasArgumentsParser
- parseWithResult(GlobalMetadata<T>, Iterable<String>) - Method in class com.github.rvesse.airline.parser.command.CliParser
- parseWithResult(ParserMetadata<T>, CommandMetadata, Iterable<GlobalRestriction>, Iterable<String>) - Method in class com.github.rvesse.airline.parser.command.SingleCommandParser
- parseWithResult(Iterable<String>) - Method in class com.github.rvesse.airline.Cli
-
Parses the arguments to produce a result.
- parseWithResult(Iterable<String>) - Method in class com.github.rvesse.airline.SingleCommand
-
Parses the arguments to produce a result.
- parseWithResult(String...) - Method in class com.github.rvesse.airline.Cli
-
Parses the arguments to produce a result.
- parseWithResult(String...) - Method in class com.github.rvesse.airline.SingleCommand
-
Parses the arguments to produce a result.
- Partial - Annotation Type in com.github.rvesse.airline.annotations.restrictions
-
Annotation which is used as a modifier to indicate that a restriction annotation (whose type is denoted by the
Partial.restriction()
field) does not apply to all values passed to anOption
orArguments
annotated field but rather applies only to certain values - PartialRestriction - Class in com.github.rvesse.airline.restrictions.common
- PartialRestriction(int[], ArgumentsRestriction) - Constructor for class com.github.rvesse.airline.restrictions.common.PartialRestriction
- PartialRestriction(int[], OptionRestriction) - Constructor for class com.github.rvesse.airline.restrictions.common.PartialRestriction
- PartialRestriction(ArgumentsRestriction) - Constructor for class com.github.rvesse.airline.restrictions.common.PartialRestriction
- PartialRestriction(OptionRestriction) - Constructor for class com.github.rvesse.airline.restrictions.common.PartialRestriction
- PartialRestriction(Collection<Integer>, ArgumentsRestriction) - Constructor for class com.github.rvesse.airline.restrictions.common.PartialRestriction
- PartialRestriction(Collection<Integer>, OptionRestriction) - Constructor for class com.github.rvesse.airline.restrictions.common.PartialRestriction
- Partials - Annotation Type in com.github.rvesse.airline.annotations.restrictions
- password - Variable in class com.github.rvesse.airline.examples.modules.CredentialsModule
- path - Variable in class com.github.rvesse.airline.Accessor
- path - Variable in class com.github.rvesse.airline.examples.simple.Paths.PathSource
- Path - Annotation Type in com.github.rvesse.airline.annotations.restrictions
-
Annotation that marks that an options value must be a valid path to a file/directory
- PathKind - Enum in com.github.rvesse.airline.annotations.restrictions
-
Enumeration of path kinds
- PathKind() - Constructor for enum com.github.rvesse.airline.annotations.restrictions.PathKind
- PathRestriction - Class in com.github.rvesse.airline.restrictions.common
-
Implements restriction on options and arguments that expect to receive a path to a file and/or directory
- PathRestriction(boolean, boolean, boolean, boolean, PathKind) - Constructor for class com.github.rvesse.airline.restrictions.common.PathRestriction
-
Creates a new path restriction
- PathRestrictionFactory - Class in com.github.rvesse.airline.restrictions.factories
- PathRestrictionFactory() - Constructor for class com.github.rvesse.airline.restrictions.factories.PathRestrictionFactory
- paths - Variable in class com.github.rvesse.airline.examples.simple.Paths
- Paths - Class in com.github.rvesse.airline.examples.simple
- Paths() - Constructor for class com.github.rvesse.airline.examples.simple.Paths
- Paths.PathSource - Class in com.github.rvesse.airline.examples.simple
- PathSource(String, String) - Constructor for class com.github.rvesse.airline.examples.simple.Paths.PathSource
- pattern - Variable in class com.github.rvesse.airline.jpms.debug.Debug
- pattern - Variable in class com.github.rvesse.airline.restrictions.common.PatternRestriction
- pattern() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.Pattern
-
The regular expression that must be matched
- Pattern - Annotation Type in com.github.rvesse.airline.annotations.restrictions
-
An annotation that indicates that an options raw values must match a given regular expression
- PatternRestriction - Class in com.github.rvesse.airline.restrictions.common
-
A restriction which requires the raw values to match a given regular expression
- PatternRestriction(String, int, String) - Constructor for class com.github.rvesse.airline.restrictions.common.PatternRestriction
-
Creates a pattern restriction
- PLACEHOLDER_END - Static variable in class com.github.rvesse.airline.parser.resources.AbstractPlaceholderLocator
- PLACEHOLDER_START - Static variable in class com.github.rvesse.airline.parser.resources.AbstractPlaceholderLocator
- PLAIN - com.github.rvesse.airline.io.printers.TroffPrinter.ListType
- PlainText - com.github.rvesse.airline.examples.cli.aliases.Logs.Format
- popContext() - Method in class com.github.rvesse.airline.parser.ParseState
- Port - Annotation Type in com.github.rvesse.airline.annotations.restrictions
-
Annotation that indicates that an option/argument denotes a port number and its value should be restricted as such to a specific set of port classes as defined by
PortType
. - PortRange - Interface in com.github.rvesse.airline.restrictions.common
-
Interface for port ranges, useful if you want to use the
PortRestriction
with a custom port range implementation - PortRange - Annotation Type in com.github.rvesse.airline.annotations.restrictions
-
Annotation that indicates that an option/argument denotes a port number and its value should be restricted as such to a specific set of ports.
- PortRangeImpl - Class in com.github.rvesse.airline.restrictions.common
-
Concrete implementation of a port range
- PortRangeImpl(int, int) - Constructor for class com.github.rvesse.airline.restrictions.common.PortRangeImpl
-
Creates a new port range
- PortRanges - Annotation Type in com.github.rvesse.airline.annotations.restrictions
-
Annotation that indicates that an option/argument denotes a port number and its value should be restricted as such to a specific set of ports.
- PortRestriction - Class in com.github.rvesse.airline.restrictions.common
- PortRestriction(PortRange...) - Constructor for class com.github.rvesse.airline.restrictions.common.PortRestriction
- PortRestrictionFactory - Class in com.github.rvesse.airline.restrictions.factories
- PortRestrictionFactory() - Constructor for class com.github.rvesse.airline.restrictions.factories.PortRestrictionFactory
- PortType - Enum in com.github.rvesse.airline.annotations.restrictions
-
Port types
- PortType(int, int) - Constructor for enum com.github.rvesse.airline.annotations.restrictions.PortType
- PositionalAliasedCli - Class in com.github.rvesse.airline.examples.cli.aliases
-
An example of creating a CLI that takes advantage of the aliases feature.
- PositionalAliasedCli() - Constructor for class com.github.rvesse.airline.examples.cli.aliases.PositionalAliasedCli
- positive - Variable in class com.github.rvesse.airline.restrictions.common.PositiveNegativeRestriction
- Positive - Annotation Type in com.github.rvesse.airline.annotations.restrictions.ranges
-
Annotation that marks values as being restricted to being a positive value
- PositiveNegativeRestriction - Class in com.github.rvesse.airline.restrictions.common
-
Restriction that enforces that values must be either positive/negative with zero optionally included
- PositiveNegativeRestriction(boolean, boolean) - Constructor for class com.github.rvesse.airline.restrictions.common.PositiveNegativeRestriction
-
Creates a new restriction
- PostalAddress - Class in com.github.rvesse.airline.examples.sendit
-
Represents a UK postal address
- PostalAddress() - Constructor for class com.github.rvesse.airline.examples.sendit.PostalAddress
- PostalService - Enum in com.github.rvesse.airline.examples.sendit
-
Grades of postal service
- PostalService(double) - Constructor for enum com.github.rvesse.airline.examples.sendit.PostalService
- postamble - Variable in class com.github.rvesse.airline.help.sections.common.BasicSection
- postCode - Variable in class com.github.rvesse.airline.examples.sendit.PostalAddress
- postCodes - Variable in class com.github.rvesse.airline.examples.sendit.CheckPostcodes
- postValidate(ParseState<T>, ArgumentsMetadata, Object) - Method in class com.github.rvesse.airline.examples.userguide.restrictions.custom.MultipleOfRestriction
- postValidate(ParseState<T>, ArgumentsMetadata, Object) - Method in class com.github.rvesse.airline.restrictions.AbstractCommonRestriction
- postValidate(ParseState<T>, ArgumentsMetadata, Object) - Method in interface com.github.rvesse.airline.restrictions.ArgumentsRestriction
-
Method that is called after Airline has converted a string argument received into a strongly typed Java value
- postValidate(ParseState<T>, ArgumentsMetadata, Object) - Method in class com.github.rvesse.airline.restrictions.common.AllowedValuesRestriction
- postValidate(ParseState<T>, ArgumentsMetadata, Object) - Method in class com.github.rvesse.airline.restrictions.common.PartialRestriction
- postValidate(ParseState<T>, ArgumentsMetadata, Object) - Method in class com.github.rvesse.airline.restrictions.common.PortRestriction
- postValidate(ParseState<T>, ArgumentsMetadata, Object) - Method in class com.github.rvesse.airline.restrictions.common.PositiveNegativeRestriction
- postValidate(ParseState<T>, ArgumentsMetadata, Object) - Method in class com.github.rvesse.airline.restrictions.common.RangeRestriction
- postValidate(ParseState<T>, OptionMetadata, Object) - Method in class com.github.rvesse.airline.examples.userguide.restrictions.custom.MultipleOfRestriction
- postValidate(ParseState<T>, OptionMetadata, Object) - Method in class com.github.rvesse.airline.restrictions.AbstractCommonRestriction
- postValidate(ParseState<T>, OptionMetadata, Object) - Method in class com.github.rvesse.airline.restrictions.common.AllowedValuesRestriction
- postValidate(ParseState<T>, OptionMetadata, Object) - Method in class com.github.rvesse.airline.restrictions.common.PartialRestriction
- postValidate(ParseState<T>, OptionMetadata, Object) - Method in class com.github.rvesse.airline.restrictions.common.PortRestriction
- postValidate(ParseState<T>, OptionMetadata, Object) - Method in class com.github.rvesse.airline.restrictions.common.PositiveNegativeRestriction
- postValidate(ParseState<T>, OptionMetadata, Object) - Method in class com.github.rvesse.airline.restrictions.common.RangeRestriction
- postValidate(ParseState<T>, OptionMetadata, Object) - Method in interface com.github.rvesse.airline.restrictions.OptionRestriction
-
Method that is called after Airline has converted a string argument received into a strongly typed Java value
- postValidate(ParseState<T>, OptionMetadata, Object) - Method in class com.github.rvesse.airline.restrictions.options.MutuallyExclusiveRestriction
- postValidate(ParseState<T>, OptionMetadata, Object) - Method in class com.github.rvesse.airline.restrictions.options.RequiredOnlyIfRestriction
- postValidate(ParseState<T>, OptionMetadata, Object) - Method in class com.github.rvesse.airline.restrictions.options.RequireFromRestriction
- preamble - Variable in class com.github.rvesse.airline.help.sections.common.BasicHint
- prefix - Variable in class com.github.rvesse.airline.builder.UserAliasSourceBuilder
- prefix - Variable in class com.github.rvesse.airline.parser.aliases.UserAliasesSource
- prefix - Variable in class com.github.rvesse.airline.types.numerics.NumericCandidate
- prefixes - Variable in class com.github.rvesse.airline.restrictions.common.StartsWithRestriction
- prefixes - Variable in class com.github.rvesse.airline.types.numerics.abbreviated.MapAbbreviatedNumericTypeConverter
- prefixes - Variable in class com.github.rvesse.airline.utils.predicates.PrefixMatcher
- prefixes() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.StartsWith
-
Prefixes that the value must possess
- PrefixMatcher - Class in com.github.rvesse.airline.utils.predicates
- PrefixMatcher(boolean, Locale, String...) - Constructor for class com.github.rvesse.airline.utils.predicates.PrefixMatcher
- prepareLine() - Method in class com.github.rvesse.airline.io.printers.TroffPrinter
- preValidate(ParseState<T>, ArgumentsMetadata, String) - Method in class com.github.rvesse.airline.restrictions.AbstractCommonRestriction
- preValidate(ParseState<T>, ArgumentsMetadata, String) - Method in interface com.github.rvesse.airline.restrictions.ArgumentsRestriction
-
Method that is called before Airline attempts to convert a string argument received into a strongly typed Java value
- preValidate(ParseState<T>, ArgumentsMetadata, String) - Method in class com.github.rvesse.airline.restrictions.common.AbstractStringRestriction
- preValidate(ParseState<T>, ArgumentsMetadata, String) - Method in class com.github.rvesse.airline.restrictions.common.AllowedEnumValuesRestriction
- preValidate(ParseState<T>, ArgumentsMetadata, String) - Method in class com.github.rvesse.airline.restrictions.common.AllowedRawValuesRestriction
- preValidate(ParseState<T>, ArgumentsMetadata, String) - Method in class com.github.rvesse.airline.restrictions.common.PartialRestriction
- preValidate(ParseState<T>, ArgumentsMetadata, String) - Method in class com.github.rvesse.airline.restrictions.common.PathRestriction
- preValidate(ParseState<T>, ArgumentsMetadata, String) - Method in class com.github.rvesse.airline.restrictions.common.PatternRestriction
- preValidate(ParseState<T>, OptionMetadata, String) - Method in class com.github.rvesse.airline.restrictions.AbstractCommonRestriction
- preValidate(ParseState<T>, OptionMetadata, String) - Method in class com.github.rvesse.airline.restrictions.common.AbstractStringRestriction
- preValidate(ParseState<T>, OptionMetadata, String) - Method in class com.github.rvesse.airline.restrictions.common.AllowedEnumValuesRestriction
- preValidate(ParseState<T>, OptionMetadata, String) - Method in class com.github.rvesse.airline.restrictions.common.AllowedRawValuesRestriction
- preValidate(ParseState<T>, OptionMetadata, String) - Method in class com.github.rvesse.airline.restrictions.common.PartialRestriction
- preValidate(ParseState<T>, OptionMetadata, String) - Method in class com.github.rvesse.airline.restrictions.common.PathRestriction
- preValidate(ParseState<T>, OptionMetadata, String) - Method in class com.github.rvesse.airline.restrictions.common.PatternRestriction
- preValidate(ParseState<T>, OptionMetadata, String) - Method in interface com.github.rvesse.airline.restrictions.OptionRestriction
-
Method that is called before Airline attempts to convert a string argument received into a strongly typed Java value
- preValidate(ParseState<T>, OptionMetadata, String) - Method in class com.github.rvesse.airline.restrictions.options.MutuallyExclusiveRestriction
- preValidate(ParseState<T>, OptionMetadata, String) - Method in class com.github.rvesse.airline.restrictions.options.RequiredOnlyIfRestriction
- preValidate(ParseState<T>, OptionMetadata, String) - Method in class com.github.rvesse.airline.restrictions.options.RequireFromRestriction
- previous - Variable in class com.github.rvesse.airline.io.ControlTracker
- Price - Class in com.github.rvesse.airline.examples.sendit
- Price() - Constructor for class com.github.rvesse.airline.examples.sendit.Price
- pricePerKilogram - Variable in enum com.github.rvesse.airline.examples.sendit.PostalService
- print(String) - Method in class com.github.rvesse.airline.io.printers.TroffPrinter
- printBold(String) - Method in class com.github.rvesse.airline.io.printers.TroffPrinter
- printBoldItalic(String) - Method in class com.github.rvesse.airline.io.printers.TroffPrinter
- printBullet() - Method in class com.github.rvesse.airline.io.printers.TroffPrinter
- printItalic(String) - Method in class com.github.rvesse.airline.io.printers.TroffPrinter
- println() - Method in class com.github.rvesse.airline.io.printers.TroffPrinter
- println(String) - Method in class com.github.rvesse.airline.io.printers.TroffPrinter
- printNumberedBullet(boolean) - Method in class com.github.rvesse.airline.io.printers.TroffPrinter
- printPlainBullet() - Method in class com.github.rvesse.airline.io.printers.TroffPrinter
- printTable(List<List<String>>, boolean) - Method in class com.github.rvesse.airline.io.printers.TroffPrinter
- printTitledBullet() - Method in class com.github.rvesse.airline.io.printers.TroffPrinter
- Prompt<TOption> - Class in com.github.rvesse.airline.prompts
-
Represents a prompt
- Prompt(PromptProvider, PromptFormatter, long, TimeUnit, String, Collection<TOption>, PromptOptionMatcher<TOption>, boolean, TypeConverter) - Constructor for class com.github.rvesse.airline.prompts.Prompt
-
Creates a new prompt
- PromptBuilder<TOption> - Class in com.github.rvesse.airline.prompts.builders
-
A prompt builder is used to define a prompt in a Fluent API style
- PromptBuilder() - Constructor for class com.github.rvesse.airline.prompts.builders.PromptBuilder
- PromptException - Exception in com.github.rvesse.airline.prompts.errors
- PromptException(String) - Constructor for exception com.github.rvesse.airline.prompts.errors.PromptException
- PromptException(String, Throwable) - Constructor for exception com.github.rvesse.airline.prompts.errors.PromptException
- promptForKey() - Method in class com.github.rvesse.airline.prompts.Prompt
-
Prompts for a single key
- promptForLine() - Method in class com.github.rvesse.airline.prompts.Prompt
-
Prompts for a line of input
- PromptFormatBuilder<TOption> - Class in com.github.rvesse.airline.prompts.builders
-
A prompt format builder is a child builder of a
PromptBuilder
used to define the prompt format in a fluent style - PromptFormatBuilder(PromptBuilder<TOption>) - Constructor for class com.github.rvesse.airline.prompts.builders.PromptFormatBuilder
- PromptFormatter - Interface in com.github.rvesse.airline.prompts.formatters
-
Interface for prompt formatters
- promptForOption(boolean) - Method in class com.github.rvesse.airline.prompts.Prompt
-
Prompts for option
- promptForSecure() - Method in class com.github.rvesse.airline.prompts.Prompt
-
Prompts for a secure input line
- promptForValue(Class<T>, boolean) - Method in class com.github.rvesse.airline.prompts.Prompt
-
Prompts for a value
- PromptOptionMatcher<TOption> - Interface in com.github.rvesse.airline.prompts.matchers
-
Interfaces for option matchers that controls how options are matched to the prompt response when using
Prompt.promptForOption(boolean)
- PromptProvider - Interface in com.github.rvesse.airline.prompts
-
A provider of prompting
- Prompts - Class in com.github.rvesse.airline.prompts
-
Provides builds for some common
- Prompts() - Constructor for class com.github.rvesse.airline.prompts.Prompts
- PromptsDemo - Class in com.github.rvesse.airline.examples.userguide.prompts
- PromptsDemo() - Constructor for class com.github.rvesse.airline.examples.userguide.prompts.PromptsDemo
- PromptTimeoutException - Exception in com.github.rvesse.airline.prompts.errors
- PromptTimeoutException(Prompt<?>, TimeoutException) - Constructor for exception com.github.rvesse.airline.prompts.errors.PromptTimeoutException
- PROSE - com.github.rvesse.airline.help.sections.HelpFormat
-
Help format is prose i.e.
- ProseSection - Class in com.github.rvesse.airline.help.sections.common
- ProseSection - Annotation Type in com.github.rvesse.airline.annotations.help
-
Annotation that provides a prose section for a commands help
- ProseSection(String, int, String[]) - Constructor for class com.github.rvesse.airline.help.sections.common.ProseSection
- ProseSection(String, int, String, String, String[]) - Constructor for class com.github.rvesse.airline.help.sections.common.ProseSection
- ProseSection(String, String[]) - Constructor for class com.github.rvesse.airline.help.sections.common.ProseSection
- provider - Variable in class com.github.rvesse.airline.io.ControlTracker
- provider - Variable in class com.github.rvesse.airline.model.ArgumentsMetadata
- provider - Variable in class com.github.rvesse.airline.model.OptionMetadata
- provider - Variable in class com.github.rvesse.airline.prompts.builders.PromptBuilder
- provider - Variable in class com.github.rvesse.airline.prompts.Prompt
- pushContext(Context) - Method in class com.github.rvesse.airline.parser.ParseState
Q
- QuestionFormat<TOption> - Class in com.github.rvesse.airline.prompts.formatters
-
Prompt format for simple questions with either a free-form response or with a limited number of options
- QuestionFormat() - Constructor for class com.github.rvesse.airline.prompts.formatters.QuestionFormat
-
Creates a new question format with default columns
- QuestionFormat(int) - Constructor for class com.github.rvesse.airline.prompts.formatters.QuestionFormat
-
Creates a new question format with the specified columns
R
- r - Variable in class com.github.rvesse.airline.io.colors.TrueColor
- range - Variable in class com.github.rvesse.airline.restrictions.common.LengthRestriction
- range - Variable in class com.github.rvesse.airline.restrictions.common.PositiveNegativeRestriction
- RangeRestriction - Class in com.github.rvesse.airline.restrictions.common
-
A restriction that requires the value (after type conversion) to be within a given range
- RangeRestriction(Object, boolean, Object, boolean, Comparator<Object>) - Constructor for class com.github.rvesse.airline.restrictions.common.RangeRestriction
- RangeRestrictionFactory - Class in com.github.rvesse.airline.restrictions.factories
-
Factory which generates range restrictions from a variety of different range annotations
- RangeRestrictionFactory() - Constructor for class com.github.rvesse.airline.restrictions.factories.RangeRestrictionFactory
- rawOutput - Variable in class com.github.rvesse.airline.prompts.console.StreamPrompt
- rawValues - Variable in class com.github.rvesse.airline.restrictions.common.AbstractAllowedValuesRestriction
- readable - Variable in class com.github.rvesse.airline.restrictions.common.PathRestriction
- readable() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.Directory
-
Gets/Sets whether the given directory must be readable
- readable() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.File
-
Gets/Sets whether the given file must be readable
- readable() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.Path
-
Gets/Sets whether the given file must be readable
- reader - Variable in class com.github.rvesse.airline.prompts.console.StreamPrompt
- readKey() - Method in class com.github.rvesse.airline.prompts.console.ConsolePrompt
- readKey() - Method in class com.github.rvesse.airline.prompts.console.StreamPrompt
- readKey() - Method in interface com.github.rvesse.airline.prompts.PromptProvider
-
Reads a single key from the prompts source
- readLine() - Method in class com.github.rvesse.airline.prompts.console.ConsolePrompt
- readLine() - Method in class com.github.rvesse.airline.prompts.console.StreamPrompt
- readLine() - Method in interface com.github.rvesse.airline.prompts.PromptProvider
-
Reads a line from the prompts source
- readSecureLine() - Method in class com.github.rvesse.airline.prompts.console.ConsolePrompt
- readSecureLine() - Method in class com.github.rvesse.airline.prompts.console.StreamPrompt
- readSecureLine() - Method in interface com.github.rvesse.airline.prompts.PromptProvider
-
Reads a line from the prompts source in a secure manner
- recipient - Variable in class com.github.rvesse.airline.examples.sendit.PostalAddress
- red - Variable in class com.github.rvesse.airline.examples.io.ColorsTrue
- RED - com.github.rvesse.airline.io.colors.BasicColor
- referenceChain - Variable in exception com.github.rvesse.airline.parser.errors.ParseAliasCircularReferenceException
- registerControl(OutputStreamControlTracker) - Method in class com.github.rvesse.airline.io.output.AnsiOutputStream
-
Registers a control
- registerControl(WriterControlTracker) - Method in class com.github.rvesse.airline.io.writers.AnsiWriter
- registerControls(OutputStreamControlTracker...) - Method in class com.github.rvesse.airline.io.output.AnsiOutputStream
-
Registers some controls
- registerControls(WriterControlTracker...) - Method in class com.github.rvesse.airline.io.writers.AnsiWriter
- RelatedCommands - Annotation Type in com.github.rvesse.airline.examples.userguide.help.sections.custom
- RelatedCommandsFactory - Class in com.github.rvesse.airline.examples.userguide.help.sections.custom
- RelatedCommandsFactory() - Constructor for class com.github.rvesse.airline.examples.userguide.help.sections.custom.RelatedCommandsFactory
- RelatedCommandsSection - Class in com.github.rvesse.airline.examples.userguide.help.sections.custom
- RelatedCommandsSection(String[]) - Constructor for class com.github.rvesse.airline.examples.userguide.help.sections.custom.RelatedCommandsSection
- repeat(Writer, int, char) - Method in class com.github.rvesse.airline.help.cli.bash.BashCompletionGenerator
- REQUEST_BREAK - Static variable in class com.github.rvesse.airline.io.printers.TroffPrinter
- REQUEST_FONT_BOLD - Static variable in class com.github.rvesse.airline.io.printers.TroffPrinter
- REQUEST_FONT_BOLD_ITALIC - Static variable in class com.github.rvesse.airline.io.printers.TroffPrinter
- REQUEST_FONT_ITALIC - Static variable in class com.github.rvesse.airline.io.printers.TroffPrinter
- REQUEST_FONT_ROMAN - Static variable in class com.github.rvesse.airline.io.printers.TroffPrinter
- REQUEST_MOVE_LEFT_MARGIN - Static variable in class com.github.rvesse.airline.io.printers.TroffPrinter
- REQUEST_PARAGRAPH_CURRENT_INDENTATION - Static variable in class com.github.rvesse.airline.io.printers.TroffPrinter
- REQUEST_PARAGRAPH_NO_INDENTATION - Static variable in class com.github.rvesse.airline.io.printers.TroffPrinter
- REQUEST_PARAGRAPH_TITLED - Static variable in class com.github.rvesse.airline.io.printers.TroffPrinter
- REQUEST_RESET_LEFT_MARGIN - Static variable in class com.github.rvesse.airline.io.printers.TroffPrinter
- REQUEST_TABLE_END - Static variable in class com.github.rvesse.airline.io.printers.TroffPrinter
- REQUEST_TABLE_START - Static variable in class com.github.rvesse.airline.io.printers.TroffPrinter
- required - Variable in class com.github.rvesse.airline.examples.simple.Required
- Required - Class in com.github.rvesse.airline.examples.simple
-
A command that has some required options
- Required - Annotation Type in com.github.rvesse.airline.annotations.restrictions
-
An annotation that indicates that an option/arguments is required
- Required() - Constructor for class com.github.rvesse.airline.examples.simple.Required
- RequiredArguments - Class in com.github.rvesse.airline.examples.simple
-
An example command that has required arguments
- RequiredArguments() - Constructor for class com.github.rvesse.airline.examples.simple.RequiredArguments
- RequiredFromFinder - Class in com.github.rvesse.airline.utils.predicates.restrictions
- RequiredFromFinder() - Constructor for class com.github.rvesse.airline.utils.predicates.restrictions.RequiredFromFinder
- RequiredFromFinder(String) - Constructor for class com.github.rvesse.airline.utils.predicates.restrictions.RequiredFromFinder
- RequiredOnlyIf - Annotation Type in com.github.rvesse.airline.annotations.restrictions
-
An annotation that indicates that an option/arguments is required only if some other option/options are present
- RequiredOnlyIfRestriction - Class in com.github.rvesse.airline.restrictions.options
- RequiredOnlyIfRestriction(String...) - Constructor for class com.github.rvesse.airline.restrictions.options.RequiredOnlyIfRestriction
- RequiredOnlyIfRestrictionFactory - Class in com.github.rvesse.airline.restrictions.factories
- RequiredOnlyIfRestrictionFactory() - Constructor for class com.github.rvesse.airline.restrictions.factories.RequiredOnlyIfRestrictionFactory
- RequiredOption - Class in com.github.rvesse.airline.examples.userguide.restrictions
- RequiredOption() - Constructor for class com.github.rvesse.airline.examples.userguide.restrictions.RequiredOption
- RequiredTagOptionFinder - Class in com.github.rvesse.airline.utils.predicates.restrictions
- RequiredTagOptionFinder(String) - Constructor for class com.github.rvesse.airline.utils.predicates.restrictions.RequiredTagOptionFinder
- RequiredTagParsedOptionFinder - Class in com.github.rvesse.airline.utils.predicates.restrictions
- RequiredTagParsedOptionFinder(String) - Constructor for class com.github.rvesse.airline.utils.predicates.restrictions.RequiredTagParsedOptionFinder
- RequiredUnlessEnvironment - Annotation Type in com.github.rvesse.airline.annotations.restrictions
-
An annotation that indicates that an option/arguments is required UNLESS a specific environment variable is set.
- RequiredUnlessEnvironmentRestriction - Class in com.github.rvesse.airline.restrictions.options
-
A restriction that requires an option/argument be set UNLESS a suitable environment variable is specified.
- RequiredUnlessEnvironmentRestriction(String[]) - Constructor for class com.github.rvesse.airline.restrictions.options.RequiredUnlessEnvironmentRestriction
- RequiredUnlessEnvironmentRestriction.IsEnvVarSet - Class in com.github.rvesse.airline.restrictions.options
- RequireFromRestriction - Class in com.github.rvesse.airline.restrictions.options
- RequireFromRestriction(String, boolean) - Constructor for class com.github.rvesse.airline.restrictions.options.RequireFromRestriction
- RequireFromRestrictionFactory - Class in com.github.rvesse.airline.restrictions.factories
- RequireFromRestrictionFactory() - Constructor for class com.github.rvesse.airline.restrictions.factories.RequireFromRestrictionFactory
- RequireOnlyOne - Annotation Type in com.github.rvesse.airline.annotations.restrictions
-
Annotation that indicates that you only permit one option from some set of options to be present, the set of options are identified by a user defined tag.
- RequireSome - Annotation Type in com.github.rvesse.airline.annotations.restrictions
-
This annotation denotes that at least one of some set of options are required, the set of options are identified by a user defined tag.
- requireWrite - Variable in class com.github.rvesse.airline.io.ControlTracker
- reset() - Static method in class com.github.rvesse.airline.help.sections.factories.HelpSectionRegistry
-
Resets the registry causing it to re-invoke
ServiceLoader.load(Class)
to reload declared services - reset() - Method in class com.github.rvesse.airline.io.ControlTracker
-
Resets the control to the default unintialized state, if necessary this will will cause the
- reset() - Static method in class com.github.rvesse.airline.restrictions.factories.RestrictionRegistry
-
Resets the registry to its default state
- reset(boolean) - Method in class com.github.rvesse.airline.io.output.AnsiOutputStream
-
Resets the stream to the default state i.e.
- RESET - Static variable in class com.github.rvesse.airline.io.AnsiControlCodes
-
Character used to request reset
- resetAll() - Method in class com.github.rvesse.airline.io.output.AnsiOutputStream
-
Method which resets the state of any controls that have been previously enabled and applied to the stream
- resetAll() - Method in class com.github.rvesse.airline.io.writers.AnsiWriter
- resetBackgroundColor() - Method in class com.github.rvesse.airline.io.output.ColorizedOutputStream
- resetBackgroundColor() - Method in class com.github.rvesse.airline.io.writers.ColorizedWriter
- resetCollection() - Method in class com.github.rvesse.airline.parser.errors.handlers.AbstractCollectingHandler
- resetForegroundColor() - Method in class com.github.rvesse.airline.io.output.ColorizedOutputStream
- resetForegroundColor() - Method in class com.github.rvesse.airline.io.writers.ColorizedWriter
- resetInternal(T) - Method in class com.github.rvesse.airline.io.ControlTracker
-
Method that derived classes must implement to add the actual logic for resetting the control against the stream
- resetInternal(T) - Method in class com.github.rvesse.airline.io.output.OutputStreamControlTracker
- resetInternal(T) - Method in class com.github.rvesse.airline.io.writers.WriterControlTracker
- resolve(String) - Method in class com.github.rvesse.airline.parser.resources.AbstractPlaceholderLocator
- resolve(String) - Method in class com.github.rvesse.airline.parser.resources.FileLocator
-
Resolves the search location
- resolve(String) - Method in class com.github.rvesse.airline.parser.resources.HomeDirectoryLocator
- resolve(String) - Method in class com.github.rvesse.airline.parser.resources.WorkingDirectoryLocator
- resolveAliases(PeekingIterator<String>, ParseState<T>) - Method in class com.github.rvesse.airline.parser.aliases.AliasResolver
- resolvePlaceholder(String) - Method in class com.github.rvesse.airline.parser.resources.AbstractPlaceholderLocator
-
Resolves a placeholder
- resolvePlaceholder(String) - Method in class com.github.rvesse.airline.parser.resources.EnvVarLocator
- resolvePlaceholder(String) - Method in class com.github.rvesse.airline.parser.resources.JvmSystemPropertyLocator
- ResourceLocator - Interface in com.github.rvesse.airline.parser.resources
-
Interface for making resource search locations extensible e.g.
- response - Variable in class com.github.rvesse.airline.prompts.matchers.MatcherUtils.Exact
- response - Variable in class com.github.rvesse.airline.prompts.matchers.MatcherUtils.ExactIgnoresCase
- response - Variable in class com.github.rvesse.airline.prompts.matchers.MatcherUtils.ExactOrStartsWith
- response - Variable in class com.github.rvesse.airline.prompts.matchers.MatcherUtils.ExactOrStartsWithIgnoresCase
- restriction() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.Partial
-
Specifies the restriction type whose application should be partial
- RestrictionRegistry - Class in com.github.rvesse.airline.restrictions.factories
-
Central registry for restrictions
- RestrictionRegistry() - Constructor for class com.github.rvesse.airline.restrictions.factories.RestrictionRegistry
- restrictions - Variable in class com.github.rvesse.airline.builder.CliBuilder
- restrictions - Variable in class com.github.rvesse.airline.model.ArgumentsMetadata
- restrictions - Variable in class com.github.rvesse.airline.model.GlobalMetadata
- restrictions - Variable in class com.github.rvesse.airline.model.OptionMetadata
- restrictions - Variable in class com.github.rvesse.airline.SingleCommand
- restrictions() - Method in annotation type com.github.rvesse.airline.annotations.Cli
-
Defines the classes that provide global restrictions for the CLI
- result - Variable in class com.github.rvesse.airline.parser.resources.jpms.ScanResultInputStream
- REVEAL - Static variable in class com.github.rvesse.airline.io.AnsiControlCodes
- rowToArray(List<List<String>>, int) - Method in class com.github.rvesse.airline.help.external.factories.ExternalHelpFactory
-
Converts one column of a list of rows into an array
- rowToNumericArray(List<List<String>>, int, String) - Method in class com.github.rvesse.airline.help.external.factories.ExternalHelpFactory
-
Converts one column of a list of rows into an array
- run() - Method in class com.github.rvesse.airline.examples.cli.aliases.Logs
- run() - Method in class com.github.rvesse.airline.examples.cli.commands.BashCompletion
- run() - Method in class com.github.rvesse.airline.examples.cli.commands.Help
- run() - Method in class com.github.rvesse.airline.examples.cli.commands.Manuals
- run() - Method in interface com.github.rvesse.airline.examples.ExampleRunnable
-
Runs the command and returns an exit code that the application should return
- run() - Method in class com.github.rvesse.airline.examples.inheritance.Child
- run() - Method in class com.github.rvesse.airline.examples.inheritance.MaybeVerboseCommand
- run() - Method in class com.github.rvesse.airline.examples.inheritance.Parent
- run() - Method in class com.github.rvesse.airline.examples.io.ColorDemo
- run() - Method in class com.github.rvesse.airline.examples.io.Decorations
- run() - Method in class com.github.rvesse.airline.examples.modules.ModuleReuse
- run() - Method in class com.github.rvesse.airline.examples.modules.Modules
- run() - Method in class com.github.rvesse.airline.examples.sendit.CheckAddress
- run() - Method in class com.github.rvesse.airline.examples.sendit.CheckPostcodes
- run() - Method in class com.github.rvesse.airline.examples.sendit.Price
- run() - Method in class com.github.rvesse.airline.examples.sendit.Send
- run() - Method in class com.github.rvesse.airline.examples.simple.Required
- run() - Method in class com.github.rvesse.airline.examples.simple.RequiredArguments
- run() - Method in class com.github.rvesse.airline.examples.simple.Simple
- run() - Method in class com.github.rvesse.airline.examples.userguide.GettingStarted
- run() - Method in class com.github.rvesse.airline.examples.userguide.help.bash.FileInfo
- run() - Method in class com.github.rvesse.airline.examples.userguide.help.sections.Discussed
- run() - Method in class com.github.rvesse.airline.examples.userguide.help.sections.ExternalHelp
- run() - Method in class com.github.rvesse.airline.examples.userguide.parser.ByteCalculator
- run() - Method in class com.github.rvesse.airline.examples.userguide.prompts.PromptsDemo
- run() - Method in class com.github.rvesse.airline.examples.userguide.Tool
- run() - Method in class com.github.rvesse.airline.help.Help
- run() - Method in class com.github.rvesse.airline.help.suggester.SuggestCommand
- run() - Method in class com.github.rvesse.airline.jpms.debug.Debug
S
- ScanResultInputStream - Class in com.github.rvesse.airline.parser.resources.jpms
-
A wrapper around an InputStream originating from a
ScanResult
to ensure that it is closed when the stream is closed - ScanResultInputStream(ScanResult, InputStream) - Constructor for class com.github.rvesse.airline.parser.resources.jpms.ScanResultInputStream
-
Creates a wrapper around an
InputStream
that was creating from a Class GraphScanResult
. - sealed - Variable in class com.github.rvesse.airline.model.OptionMetadata
- sealed() - Method in annotation type com.github.rvesse.airline.annotations.Option
-
If true this parameter cannot be overridden by parameters of the same name declared in child classes regardless of whether the child class declares the
Option.override()
property to be true - searchLocations - Variable in class com.github.rvesse.airline.builder.UserAliasSourceBuilder
- searchLocations - Variable in class com.github.rvesse.airline.parser.aliases.UserAliasesSource
- SecondClass - com.github.rvesse.airline.examples.sendit.PostalService
- sections - Variable in class com.github.rvesse.airline.model.CommandMetadata
- SeeAlso - Annotation Type in com.github.rvesse.airline.annotations.help
-
Annotation that provides a see also section in help
- SELECT_GRAPHIC_RENDITION - Static variable in class com.github.rvesse.airline.io.AnsiControlCodes
-
Command code for setting the graphics rendition
- Send - Class in com.github.rvesse.airline.examples.sendit
- Send() - Constructor for class com.github.rvesse.airline.examples.sendit.Send
- SendIt - Class in com.github.rvesse.airline.examples.sendit
- SendIt() - Constructor for class com.github.rvesse.airline.examples.sendit.SendIt
- SendItCli - Class in com.github.rvesse.airline.examples.sendit
- SendItCli() - Constructor for class com.github.rvesse.airline.examples.sendit.SendItCli
- separator - Variable in class com.github.rvesse.airline.parser.options.AbstractNameValueOptionParser
- separator - Variable in class com.github.rvesse.airline.parser.options.ListValueOptionParser
- separator - Variable in class com.github.rvesse.airline.parser.options.MaybePairValueOptionParser
- sequence - Variable in class com.github.rvesse.airline.parser.aliases.AliasArgumentsParser
- SequenceAbbreviatedNumericTypeConverter - Class in com.github.rvesse.airline.types.numerics.abbreviated
- SequenceAbbreviatedNumericTypeConverter(boolean, Map<String, Integer>, long, String...) - Constructor for class com.github.rvesse.airline.types.numerics.abbreviated.SequenceAbbreviatedNumericTypeConverter
- serialVersionUID - Static variable in exception com.github.rvesse.airline.parser.errors.ParseAliasCircularReferenceException
- serialVersionUID - Static variable in exception com.github.rvesse.airline.parser.errors.ParseArgumentsIllegalValueException
- serialVersionUID - Static variable in exception com.github.rvesse.airline.parser.errors.ParseArgumentsMissingException
- serialVersionUID - Static variable in exception com.github.rvesse.airline.parser.errors.ParseArgumentsUnexpectedException
- serialVersionUID - Static variable in exception com.github.rvesse.airline.parser.errors.ParseCommandMissingException
- serialVersionUID - Static variable in exception com.github.rvesse.airline.parser.errors.ParseCommandUnrecognizedException
- serialVersionUID - Static variable in exception com.github.rvesse.airline.parser.errors.ParseException
- serialVersionUID - Static variable in exception com.github.rvesse.airline.parser.errors.ParseInvalidRestrictionException
- serialVersionUID - Static variable in exception com.github.rvesse.airline.parser.errors.ParseOptionConversionException
- serialVersionUID - Static variable in exception com.github.rvesse.airline.parser.errors.ParseOptionGroupException
- serialVersionUID - Static variable in exception com.github.rvesse.airline.parser.errors.ParseOptionIllegalValueException
- serialVersionUID - Static variable in exception com.github.rvesse.airline.parser.errors.ParseOptionMissingException
- serialVersionUID - Static variable in exception com.github.rvesse.airline.parser.errors.ParseOptionMissingValueException
- serialVersionUID - Static variable in exception com.github.rvesse.airline.parser.errors.ParseOptionOutOfRangeException
- serialVersionUID - Static variable in exception com.github.rvesse.airline.parser.errors.ParseOptionUnexpectedException
- serialVersionUID - Static variable in exception com.github.rvesse.airline.parser.errors.ParseRestrictionViolatedException
- serialVersionUID - Static variable in exception com.github.rvesse.airline.parser.errors.ParseTooManyArgumentsException
- serialVersionUID - Static variable in exception com.github.rvesse.airline.prompts.errors.PromptException
- serialVersionUID - Static variable in exception com.github.rvesse.airline.prompts.errors.PromptTimeoutException
- service - Variable in class com.github.rvesse.airline.examples.sendit.Price
- service - Variable in class com.github.rvesse.airline.examples.sendit.Send
- set(T) - Method in class com.github.rvesse.airline.io.ControlTracker
-
Sets the value for the control
- setBackgroundColor(T) - Method in class com.github.rvesse.airline.io.output.ColorizedOutputStream
- setBackgroundColor(T) - Method in class com.github.rvesse.airline.io.writers.ColorizedWriter
- setBold(boolean) - Method in class com.github.rvesse.airline.io.output.ColorizedOutputStream
- setBold(boolean) - Method in class com.github.rvesse.airline.io.writers.ColorizedWriter
- setDecoration(boolean, BasicDecoration, OutputStreamControlTracker<BasicDecoration>) - Method in class com.github.rvesse.airline.io.output.ColorizedOutputStream
- setDecoration(boolean, BasicDecoration, WriterControlTracker<BasicDecoration>) - Method in class com.github.rvesse.airline.io.writers.ColorizedWriter
- setForegroundColor(T) - Method in class com.github.rvesse.airline.io.output.ColorizedOutputStream
- setForegroundColor(T) - Method in class com.github.rvesse.airline.io.writers.ColorizedWriter
- setItalic(boolean) - Method in class com.github.rvesse.airline.io.output.ColorizedOutputStream
- setItalic(boolean) - Method in class com.github.rvesse.airline.io.writers.ColorizedWriter
- setNumericConverter(NumericTypeConverter) - Method in class com.github.rvesse.airline.types.DefaultTypeConverter
- setNumericConverter(NumericTypeConverter) - Method in interface com.github.rvesse.airline.types.TypeConverter
-
Sets the numeric type converter to use, if
null
then default behaviour of the type converter instance (whatever that might be) will be used - setParent(CommandGroupMetadata) - Method in class com.github.rvesse.airline.model.CommandGroupMetadata
-
Sets the parent for a group
- setStrikeThrough(boolean) - Method in class com.github.rvesse.airline.io.output.ColorizedOutputStream
- setStrikeThrough(boolean) - Method in class com.github.rvesse.airline.io.writers.ColorizedWriter
- setUnderline(boolean) - Method in class com.github.rvesse.airline.io.output.ColorizedOutputStream
- setUnderline(boolean) - Method in class com.github.rvesse.airline.io.writers.ColorizedWriter
- SHORT_COMPARATOR - Static variable in class com.github.rvesse.airline.restrictions.factories.RangeRestrictionFactory
- SHORT_OPTIONS_PREFIX - Static variable in class com.github.rvesse.airline.parser.options.AbstractOptionParser
- ShortComparator - Class in com.github.rvesse.airline.utils.comparators
- ShortComparator() - Constructor for class com.github.rvesse.airline.utils.comparators.ShortComparator
- ShortRange - Annotation Type in com.github.rvesse.airline.annotations.restrictions.ranges
-
Annotation that marks values as being restricted to a given short integer range
- shortRestrictor - Variable in class com.github.rvesse.airline.restrictions.common.PositiveNegativeRestriction
- showHelp() - Method in class com.github.rvesse.airline.HelpOption
-
Shows help using the default
CliCommandUsageGenerator
- showHelp(CommandUsageGenerator) - Method in class com.github.rvesse.airline.HelpOption
-
Shows help using the given usage generator
- showHelpIfErrors(ParseResult<T>) - Method in class com.github.rvesse.airline.HelpOption
-
Shows help if any parsing errors were detected.
- showHelpIfErrors(ParseResult<T>, boolean) - Method in class com.github.rvesse.airline.HelpOption
-
Shows help if any parsing errors were detected
- showHelpIfErrors(ParseResult<T>, boolean, CommandUsageGenerator) - Method in class com.github.rvesse.airline.HelpOption
-
Shows help if any parsing errors were detected
- showHelpIfRequested() - Method in class com.github.rvesse.airline.HelpOption
-
Shows help if user requested it and it hasn't already been shown using the default
CliCommandUsageGenerator
- showHelpIfRequested(CommandUsageGenerator) - Method in class com.github.rvesse.airline.HelpOption
-
Shows help if user requested it, and it hasn't already been shown
- showModuleName - Variable in class com.github.rvesse.airline.jpms.debug.Debug
- shown - Variable in class com.github.rvesse.airline.HelpOption
- Simple - Class in com.github.rvesse.airline.examples.simple
-
A simple example that demonstrates most of the basic concepts
- Simple() - Constructor for class com.github.rvesse.airline.examples.simple.Simple
- SimpleCli - Class in com.github.rvesse.airline.examples.cli
-
A simple example of creating a CLI
- SimpleCli() - Constructor for class com.github.rvesse.airline.examples.cli.SimpleCli
- SimpleRestrictionsFactory - Class in com.github.rvesse.airline.restrictions.factories
- SimpleRestrictionsFactory() - Constructor for class com.github.rvesse.airline.restrictions.factories.SimpleRestrictionsFactory
- singleCommand(Class<C>) - Static method in class com.github.rvesse.airline.SingleCommand
-
Creates a new single command
- singleCommand(Class<C>, ParserMetadata<C>) - Static method in class com.github.rvesse.airline.SingleCommand
-
Creates a new single command
- SingleCommand<C> - Class in com.github.rvesse.airline
-
Class for encapsulating and parsing single commands
- SingleCommand(Class<C>, Iterable<GlobalRestriction>, ParserMetadata<C>) - Constructor for class com.github.rvesse.airline.SingleCommand
- SingleCommandParser<T> - Class in com.github.rvesse.airline.parser.command
- SingleCommandParser() - Constructor for class com.github.rvesse.airline.parser.command.SingleCommandParser
- singletonMap(K, V) - Static method in class com.github.rvesse.airline.utils.AirlineUtils
- singleValue - Variable in class com.github.rvesse.airline.restrictions.common.RangeRestriction
- sortArgumentsRestrictions(List<ArgumentsRestriction>) - Method in class com.github.rvesse.airline.help.common.AbstractUsageGenerator
- sortCommandGroups(List<CommandGroupMetadata>) - Method in class com.github.rvesse.airline.help.common.AbstractGlobalUsageGenerator
-
Sorts the command groups assumign a non-null comparator was provided at instantiation time
- sortCommands(List<CommandMetadata>) - Method in class com.github.rvesse.airline.help.common.AbstractUsageGenerator
-
Sorts the commands assuming a non-null comparator was provided at instantiation time
- sortExitCodes(List<Map.Entry<Integer, String>>) - Method in class com.github.rvesse.airline.help.common.AbstractCommandUsageGenerator
-
Sorts the exit codes assuming a non-null comparator was provided at instantiation time
- sortOptionRestrictions(List<OptionRestriction>) - Method in class com.github.rvesse.airline.help.common.AbstractUsageGenerator
- sortOptions(List<OptionMetadata>) - Method in class com.github.rvesse.airline.help.common.AbstractUsageGenerator
-
Sorts the options assuming a non-null comparator was provided at instantiation time
- source - Variable in class com.github.rvesse.airline.examples.simple.Paths.PathSource
- source() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalDiscussion
-
Source containing the discussion content
- source() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalExitCodes
-
Source containing the table of exit codes and their descriptions
- source() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalProse
-
Source containing the prose content
- source() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalTabularExamples
-
Source containing the examples and their descriptions in tabular format
- sourceLocators() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalDiscussion
-
Resource locators used to find the resources specified in
ExternalDiscussion.source()
- sourceLocators() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalExamples
-
Resource locators used to find the resources specified in
ExternalExamples.exampleSource()
andExternalExamples.descriptionSource()
- sourceLocators() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalExitCodes
-
Resource locators used to find the resources specified in
ExternalExitCodes.source()
- sourceLocators() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalProse
-
Resource locators used to find the resources specified in
ExternalProse.source()
- sourceLocators() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalTabularExamples
-
Resource locators used to find the resources specified in
ExternalTabularExamples.source()
- sourceLocators() - Method in annotation type com.github.rvesse.airline.annotations.help.Version
-
Resource locators used to find the properties files specified in
Version.sources()
- sourceNotFound(String) - Method in class com.github.rvesse.airline.help.sections.common.VersionSection
- sources() - Method in annotation type com.github.rvesse.airline.annotations.help.Version
-
Sets paths to resources that provide the version information
- spaces(int) - Static method in class com.github.rvesse.airline.io.printers.UsagePrinter
- SPECIAL_FILES - Static variable in class com.github.rvesse.airline.help.man.ManSections
-
Special files
- StandardGlobalRestrictionsFactory - Class in com.github.rvesse.airline.restrictions.factories
- StandardGlobalRestrictionsFactory() - Constructor for class com.github.rvesse.airline.restrictions.factories.StandardGlobalRestrictionsFactory
- StandardOptionParser<T> - Class in com.github.rvesse.airline.parser.options
-
An options parser that expects the name and value(s) to be white space separated e.g.
- StandardOptionParser() - Constructor for class com.github.rvesse.airline.parser.options.StandardOptionParser
- start(String, int) - Method in class com.github.rvesse.airline.io.printers.TroffPrinter
- start(String, int, String, String, String) - Method in class com.github.rvesse.airline.io.printers.TroffPrinter
- startBulletedList() - Method in class com.github.rvesse.airline.io.printers.TroffPrinter
- startNumberedList() - Method in class com.github.rvesse.airline.io.printers.TroffPrinter
- startPlainList() - Method in class com.github.rvesse.airline.io.printers.TroffPrinter
- StartsWith - Annotation Type in com.github.rvesse.airline.annotations.restrictions
-
Annotation that marks that an options value must start with a given string
- StartsWithRestriction - Class in com.github.rvesse.airline.restrictions.common
-
A restriction that requires raw values to start with one of a set of prefixes
- StartsWithRestriction(boolean, Locale, String...) - Constructor for class com.github.rvesse.airline.restrictions.common.StartsWithRestriction
- startTitledList() - Method in class com.github.rvesse.airline.io.printers.TroffPrinter
-
Starts a titled list, the next line of text printed will form the title
- startTitledList(String) - Method in class com.github.rvesse.airline.io.printers.TroffPrinter
-
Starts a titled list with the given title
- startYear() - Method in annotation type com.github.rvesse.airline.annotations.help.Copyright
-
Gets/Sets the start year
- state - Variable in class com.github.rvesse.airline.parser.ParseResult
- StdIOPrompt - Class in com.github.rvesse.airline.prompts.console
-
A prompt backed by
System.out
andSystem.in
- StdIOPrompt() - Constructor for class com.github.rvesse.airline.prompts.console.StdIOPrompt
-
Creates a new standard IO prompt
- StreamPrompt - Class in com.github.rvesse.airline.prompts.console
-
Creates a new prompt backed by arbitrary streams
- StreamPrompt(OutputStream, InputStream) - Constructor for class com.github.rvesse.airline.prompts.console.StreamPrompt
-
Creates a new stream prompt
- STRIKE_THROUGH - com.github.rvesse.airline.io.decorations.BasicDecoration
- STRIKE_THROUGH - Static variable in class com.github.rvesse.airline.io.AnsiControlCodes
- STRIKE_THROUGH_OFF - Static variable in class com.github.rvesse.airline.io.AnsiControlCodes
- strikeThrough - Variable in class com.github.rvesse.airline.io.output.ColorizedOutputStream
- strikeThrough - Variable in class com.github.rvesse.airline.io.writers.ColorizedWriter
- StringHierarchyComparator - Class in com.github.rvesse.airline.utils.comparators
- StringHierarchyComparator() - Constructor for class com.github.rvesse.airline.utils.comparators.StringHierarchyComparator
- StringRestrictionFactory - Class in com.github.rvesse.airline.restrictions.factories
- StringRestrictionFactory() - Constructor for class com.github.rvesse.airline.restrictions.factories.StringRestrictionFactory
- stylesheetUrls - Variable in class com.github.rvesse.airline.help.html.HtmlCommandUsageGenerator
-
List of stylesheet URLs
- subGroups - Variable in class com.github.rvesse.airline.builder.GroupBuilder
- subGroups - Variable in class com.github.rvesse.airline.model.CommandGroupMetadata
- success - Variable in class com.github.rvesse.airline.types.ConvertResult
- suffix - Variable in class com.github.rvesse.airline.types.numerics.NumericCandidate
- suffixes - Variable in class com.github.rvesse.airline.restrictions.common.EndsWithRestriction
- suffixes - Variable in class com.github.rvesse.airline.types.numerics.abbreviated.MapAbbreviatedNumericTypeConverter
- suffixes - Variable in class com.github.rvesse.airline.utils.predicates.SuffixMatcher
- suffixes() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.EndsWith
-
Suffixes that the value must possess
- SuffixMatcher - Class in com.github.rvesse.airline.utils.predicates
- SuffixMatcher(boolean, Locale, String...) - Constructor for class com.github.rvesse.airline.utils.predicates.SuffixMatcher
- suggest() - Method in class com.github.rvesse.airline.help.suggester.CommandSuggester
- suggest() - Method in class com.github.rvesse.airline.help.suggester.GlobalSuggester
- suggest() - Method in class com.github.rvesse.airline.help.suggester.GroupSuggester
- suggest() - Method in interface com.github.rvesse.airline.help.suggester.Suggester
- SuggestCommand<T> - Class in com.github.rvesse.airline.help.suggester
- SuggestCommand() - Constructor for class com.github.rvesse.airline.help.suggester.SuggestCommand
- suggestedOrder() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalProse
-
Suggested order in which the help section should be placed relative to other help sections
- suggestedOrder() - Method in annotation type com.github.rvesse.airline.annotations.help.ProseSection
-
Suggested order in which the help section should be placed relative to other help sections
- suggestedOrder() - Method in class com.github.rvesse.airline.help.sections.common.BasicSection
- suggestedOrder() - Method in class com.github.rvesse.airline.help.sections.common.VersionSection
- suggestedOrder() - Method in interface com.github.rvesse.airline.help.sections.HelpSection
-
Gets an integer indicating the suggested order that a help generator should include this section in
- Suggester - Interface in com.github.rvesse.airline.help.suggester
- suggesterClass - Variable in class com.github.rvesse.airline.model.SuggesterMetadata
- SuggesterMetadata - Class in com.github.rvesse.airline.model
- SuggesterMetadata(Class<? extends Suggester>, List<Accessor>) - Constructor for class com.github.rvesse.airline.model.SuggesterMetadata
- SuggestionParser<T> - Class in com.github.rvesse.airline.parser.suggester
- SuggestionParser() - Constructor for class com.github.rvesse.airline.parser.suggester.SuggestionParser
- SUPPORTED - Static variable in class com.github.rvesse.airline.help.external.factories.ExternalHelpFactory
-
Supported annotations
- SUPPORTED - Static variable in class com.github.rvesse.airline.help.sections.factories.CommonSectionsFactory
- supportedAnnotations() - Method in class com.github.rvesse.airline.examples.userguide.help.sections.custom.RelatedCommandsFactory
- supportedAnnotations() - Method in class com.github.rvesse.airline.help.external.factories.ExternalHelpFactory
- supportedAnnotations() - Method in class com.github.rvesse.airline.help.sections.factories.CommonSectionsFactory
- supportedAnnotations() - Method in interface com.github.rvesse.airline.help.sections.factories.HelpSectionFactory
-
Gets a list of the supported annotations
- supportedAnnotations() - Method in class com.github.rvesse.airline.restrictions.factories.AllowedValuesRestrictionFactory
- supportedAnnotations() - Method in class com.github.rvesse.airline.restrictions.factories.OccurrencesRestrictionFactory
- supportedAnnotations() - Method in class com.github.rvesse.airline.restrictions.factories.PathRestrictionFactory
- supportedAnnotations() - Method in class com.github.rvesse.airline.restrictions.factories.PortRestrictionFactory
- supportedAnnotations() - Method in class com.github.rvesse.airline.restrictions.factories.RangeRestrictionFactory
- supportedAnnotations() - Method in class com.github.rvesse.airline.restrictions.factories.SimpleRestrictionsFactory
- supportedAnnotations() - Method in class com.github.rvesse.airline.restrictions.factories.StringRestrictionFactory
- supportedArgumentsAnnotations() - Method in class com.github.rvesse.airline.examples.userguide.restrictions.custom.MultipleRestrictionFactory
- supportedArgumentsAnnotations() - Method in class com.github.rvesse.airline.restrictions.factories.AllowedValuesRestrictionFactory
- supportedArgumentsAnnotations() - Method in interface com.github.rvesse.airline.restrictions.factories.ArgumentsRestrictionFactory
-
Gets a list of annotations that this factory can convert into arguments restrictions
- supportedArgumentsAnnotations() - Method in class com.github.rvesse.airline.restrictions.factories.OccurrencesRestrictionFactory
- supportedArgumentsAnnotations() - Method in class com.github.rvesse.airline.restrictions.factories.PathRestrictionFactory
- supportedArgumentsAnnotations() - Method in class com.github.rvesse.airline.restrictions.factories.PortRestrictionFactory
- supportedArgumentsAnnotations() - Method in class com.github.rvesse.airline.restrictions.factories.RangeRestrictionFactory
- supportedArgumentsAnnotations() - Method in class com.github.rvesse.airline.restrictions.factories.RequireFromRestrictionFactory
- supportedArgumentsAnnotations() - Method in class com.github.rvesse.airline.restrictions.factories.SimpleRestrictionsFactory
- supportedArgumentsAnnotations() - Method in class com.github.rvesse.airline.restrictions.factories.StringRestrictionFactory
- supportedGlobalAnnotations() - Method in interface com.github.rvesse.airline.restrictions.factories.GlobalRestrictionFactory
-
Gets a list of annotations that this factory can convert into global restrictions
- supportedGlobalAnnotations() - Method in class com.github.rvesse.airline.restrictions.factories.StandardGlobalRestrictionsFactory
- supportedOptionAnnotations() - Method in class com.github.rvesse.airline.examples.userguide.restrictions.custom.MultipleRestrictionFactory
- supportedOptionAnnotations() - Method in class com.github.rvesse.airline.restrictions.factories.AllowedValuesRestrictionFactory
- supportedOptionAnnotations() - Method in class com.github.rvesse.airline.restrictions.factories.OccurrencesRestrictionFactory
- supportedOptionAnnotations() - Method in interface com.github.rvesse.airline.restrictions.factories.OptionRestrictionFactory
-
Gets a list of annotations that this factory can convert into option restrictions
- supportedOptionAnnotations() - Method in class com.github.rvesse.airline.restrictions.factories.PathRestrictionFactory
- supportedOptionAnnotations() - Method in class com.github.rvesse.airline.restrictions.factories.PortRestrictionFactory
- supportedOptionAnnotations() - Method in class com.github.rvesse.airline.restrictions.factories.RangeRestrictionFactory
- supportedOptionAnnotations() - Method in class com.github.rvesse.airline.restrictions.factories.RequiredOnlyIfRestrictionFactory
- supportedOptionAnnotations() - Method in class com.github.rvesse.airline.restrictions.factories.RequireFromRestrictionFactory
- supportedOptionAnnotations() - Method in class com.github.rvesse.airline.restrictions.factories.SimpleRestrictionsFactory
- supportedOptionAnnotations() - Method in class com.github.rvesse.airline.restrictions.factories.StringRestrictionFactory
- supportsSecureReads() - Method in class com.github.rvesse.airline.prompts.console.ConsolePrompt
- supportsSecureReads() - Method in class com.github.rvesse.airline.prompts.console.StreamPrompt
- supportsSecureReads() - Method in interface com.github.rvesse.airline.prompts.PromptProvider
-
Whether the provider supports secured reads
- suppressedCommand(Class<?>, CommandMetadata, String) - Static method in class com.github.rvesse.airline.model.GlobalMetadata
- suppressOnError() - Method in annotation type com.github.rvesse.airline.annotations.help.Version
-
Sets whether to suppress this help section if there is an error obtaining the version information.
- sysProps - Variable in class com.github.rvesse.airline.examples.simple.Paths
- SYSTEM - com.github.rvesse.airline.annotations.restrictions.PortType
-
The system (aka well known or privileged ports), these are ports
1
to1023
and usually require adminstrative privileges - SYSTEM_ADMIN_AND_DAEMONS - Static variable in class com.github.rvesse.airline.help.man.ManSections
-
System administration and daemons
- SYSTEM_CALLS - Static variable in class com.github.rvesse.airline.help.man.ManSections
-
System Calls
- SYSTEM_COMMANDS - com.github.rvesse.airline.help.cli.bash.CompletionBehaviour
-
OS System commands
- SystemChannelFactory - Class in com.github.rvesse.airline
-
Default implementation of
ChannelFactory
which usesSystem.out
,System.err
andSystem.in
for the channels. - SystemChannelFactory() - Constructor for class com.github.rvesse.airline.SystemChannelFactory
T
- TabDelimitedHelpParser - Class in com.github.rvesse.airline.help.external.parsers.defaults
-
An external helper parser that parses tabular resources in Tab Delimited format
- TabDelimitedHelpParser() - Constructor for class com.github.rvesse.airline.help.external.parsers.defaults.TabDelimitedHelpParser
- TABLE - com.github.rvesse.airline.help.sections.HelpFormat
-
Help format is a table, each content block will represent a column of the table
- TABLE_WITH_HEADERS - com.github.rvesse.airline.help.sections.HelpFormat
-
Help format is a table where headers are included as the first item of each column
- tabular - Variable in class com.github.rvesse.airline.help.sections.common.VersionSection
- tabular() - Method in annotation type com.github.rvesse.airline.annotations.help.Version
-
Whether to display the version information in a tabular format
- TabularParser - Interface in com.github.rvesse.airline.help.external.parsers
- tag - Variable in exception com.github.rvesse.airline.parser.errors.ParseOptionGroupException
- tag - Variable in class com.github.rvesse.airline.restrictions.options.MutuallyExclusiveRestriction
- tag - Variable in class com.github.rvesse.airline.restrictions.options.RequireFromRestriction
- tag - Variable in class com.github.rvesse.airline.utils.predicates.restrictions.MutuallyExclusiveWithFinder
- tag - Variable in class com.github.rvesse.airline.utils.predicates.restrictions.MutuallyExclusiveWithOptionFinder
- tag - Variable in class com.github.rvesse.airline.utils.predicates.restrictions.MutuallyExclusiveWithTagParsedOptionFinder
- tag - Variable in class com.github.rvesse.airline.utils.predicates.restrictions.RequiredFromFinder
- tag - Variable in class com.github.rvesse.airline.utils.predicates.restrictions.RequiredTagOptionFinder
- tag - Variable in class com.github.rvesse.airline.utils.predicates.restrictions.RequiredTagParsedOptionFinder
- tag() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.MutuallyExclusiveWith
-
Provides a tag used to identify some set of options
- tag() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.RequireOnlyOne
-
Provides a tag used to identify some set of options
- tag() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.RequireSome
-
Provides a tag used to identify some set of options
- test() - Method in class com.github.rvesse.airline.examples.simple.Paths
- testOpen - Variable in class com.github.rvesse.airline.jpms.debug.Debug
- testPrint - Variable in class com.github.rvesse.airline.jpms.debug.Debug
- timeout - Variable in class com.github.rvesse.airline.prompts.builders.PromptBuilder
- timeout - Variable in class com.github.rvesse.airline.prompts.Prompt
- timeoutUnit - Variable in class com.github.rvesse.airline.prompts.builders.PromptBuilder
- timeoutUnit - Variable in class com.github.rvesse.airline.prompts.Prompt
- title - Variable in class com.github.rvesse.airline.help.sections.common.BasicSection
- title() - Method in annotation type com.github.rvesse.airline.annotations.Arguments
-
Name or names of the arguments.
- title() - Method in annotation type com.github.rvesse.airline.annotations.help.external.ExternalProse
-
Title of the section
- title() - Method in annotation type com.github.rvesse.airline.annotations.help.HideSection
-
Sets the title of the section to hide
- title() - Method in annotation type com.github.rvesse.airline.annotations.help.ProseSection
-
Title of the section
- title() - Method in annotation type com.github.rvesse.airline.annotations.Option
-
Name use to identify the option value in documentation and error messages
- TITLE_COPYRIGHT - Static variable in class com.github.rvesse.airline.help.sections.common.CommonSections
-
Constants defining the titles of some commonly used help sections
- TITLE_DISCUSSION - Static variable in class com.github.rvesse.airline.help.sections.common.CommonSections
-
Constants defining the titles of some commonly used help sections
- TITLE_EXAMPLES - Static variable in class com.github.rvesse.airline.help.sections.common.CommonSections
-
Constants defining the titles of some commonly used help sections
- TITLE_EXIT_CODES - Static variable in class com.github.rvesse.airline.help.sections.common.CommonSections
-
Constants defining the titles of some commonly used help sections
- TITLE_LICENSE - Static variable in class com.github.rvesse.airline.help.sections.common.CommonSections
-
Constants defining the titles of some commonly used help sections
- TITLE_SEE_ALSO - Static variable in class com.github.rvesse.airline.help.sections.common.CommonSections
-
Constants defining the titles of some commonly used help sections
- TITLE_VERSION - Static variable in class com.github.rvesse.airline.help.sections.common.CommonSections
-
Constants defining the titles of some commonly used help sections
- TITLED - com.github.rvesse.airline.io.printers.TroffPrinter.ListType
- titles - Variable in class com.github.rvesse.airline.help.sections.common.VersionSection
- titles - Variable in class com.github.rvesse.airline.model.ArgumentsMetadata
- titles - Variable in class com.github.rvesse.airline.model.OptionMetadata
- titles(ParseState<T>, ArgumentsMetadata) - Method in class com.github.rvesse.airline.restrictions.common.OccurrencesRestriction
- toDefaultCommand(String) - Method in class com.github.rvesse.airline.help.common.AbstractUsageGenerator
-
Converts a command into the default command representation for the usage documentation
- toDescription(ArgumentsMetadata) - Method in class com.github.rvesse.airline.help.common.AbstractUsageGenerator
- toDescription(OptionMetadata) - Method in class com.github.rvesse.airline.help.common.AbstractUsageGenerator
- toDescription(OptionMetadata) - Method in class com.github.rvesse.airline.help.man.ManCommandUsageGenerator
- toDescription(OptionMetadata) - Method in class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator
-
Converts an option to its description form
- toGroupNames(CommandGroupMetadata) - Static method in class com.github.rvesse.airline.HelpOption
- toGroupNames(List<CommandGroupMetadata>) - Static method in class com.github.rvesse.airline.help.UsageHelper
- toHex() - Method in class com.github.rvesse.airline.io.colors.TrueColor
- toList() - Method in class com.github.rvesse.airline.help.sections.common.VersionSection.VersionInfo
- Tool - Class in com.github.rvesse.airline.examples.userguide
- Tool() - Constructor for class com.github.rvesse.airline.examples.userguide.Tool
- toOptionsList(Iterable<OptionMetadata>) - Static method in class com.github.rvesse.airline.restrictions.options.MutuallyExclusiveRestriction
- toOptionsList(Iterable<OptionMetadata>) - Static method in class com.github.rvesse.airline.restrictions.options.RequireFromRestriction
- toOrdinal(int) - Static method in class com.github.rvesse.airline.utils.AirlineUtils
- toRangesString(Set<PortRange>) - Static method in enum com.github.rvesse.airline.annotations.restrictions.PortType
-
Gets a string denoting all the acceptable port ranges
- toRangeString(Object, boolean, Object, boolean) - Static method in class com.github.rvesse.airline.utils.AirlineUtils
-
Formats the range for display
- toString() - Method in class com.github.rvesse.airline.Accessor
- toString() - Method in enum com.github.rvesse.airline.annotations.restrictions.PortType
- toString() - Method in class com.github.rvesse.airline.examples.sendit.PostalAddress
- toString() - Method in class com.github.rvesse.airline.examples.simple.Paths.PathSource
- toString() - Method in enum com.github.rvesse.airline.io.colors.BasicColor
- toString() - Method in class com.github.rvesse.airline.io.colors.Color256
- toString() - Method in class com.github.rvesse.airline.io.colors.TrueColor
- toString() - Method in enum com.github.rvesse.airline.io.decorations.BasicDecoration
- toString() - Method in class com.github.rvesse.airline.model.AliasMetadata
- toString() - Method in class com.github.rvesse.airline.model.ArgumentsMetadata
- toString() - Method in class com.github.rvesse.airline.model.CommandGroupMetadata
- toString() - Method in class com.github.rvesse.airline.model.CommandMetadata
- toString() - Method in class com.github.rvesse.airline.model.GlobalMetadata
- toString() - Method in class com.github.rvesse.airline.model.OptionMetadata
- toString() - Method in class com.github.rvesse.airline.model.ParserMetadata
- toString() - Method in class com.github.rvesse.airline.parser.ParseState
- toString() - Method in class com.github.rvesse.airline.restrictions.common.PortRangeImpl
- toString() - Method in class com.github.rvesse.airline.types.numerics.NumericCandidate
- toStrings(int[]) - Static method in class com.github.rvesse.airline.help.sections.common.ExitCodesSection
- toSynopsisUsage(List<OptionMetadata>) - Method in class com.github.rvesse.airline.help.common.AbstractUsageGenerator
-
Converts the options into their synopsis representation for the usage documentation
- toUsage(ArgumentsMetadata) - Method in class com.github.rvesse.airline.help.common.AbstractUsageGenerator
- toUsage(OptionMetadata) - Method in class com.github.rvesse.airline.help.common.AbstractUsageGenerator
- Tracked48 - com.github.rvesse.airline.examples.sendit.PostalService
- trimEnd(String) - Static method in class com.github.rvesse.airline.io.printers.UsagePrinter
- TroffPrinter - Class in com.github.rvesse.airline.io.printers
-
Printer class for generating Troff output
- TroffPrinter(PrintWriter) - Constructor for class com.github.rvesse.airline.io.printers.TroffPrinter
- TroffPrinter(PrintWriter, int, TroffPrinter.BulletStyle) - Constructor for class com.github.rvesse.airline.io.printers.TroffPrinter
- TroffPrinter.BulletStyle - Enum in com.github.rvesse.airline.io.printers
-
Supported bullet style
- TroffPrinter.ListType - Enum in com.github.rvesse.airline.io.printers
- TrueColor - Class in com.github.rvesse.airline.io.colors
-
True (24 bit) colours i.e.
- TrueColor(int, int, int) - Constructor for class com.github.rvesse.airline.io.colors.TrueColor
- TrueColor(String) - Constructor for class com.github.rvesse.airline.io.colors.TrueColor
- tryCast(Object) - Method in class com.github.rvesse.airline.utils.comparators.AbstractObjectComparator
- tryConvertBasicTypes(String, Class<?>, String) - Method in class com.github.rvesse.airline.types.DefaultTypeConverter
-
Tries to convert the value if it is one of the common Java types
- tryConvertBigDecimal(String, String) - Method in class com.github.rvesse.airline.types.numerics.ComplexNumericTypeConverter
- tryConvertBigDecimal(String, String) - Method in class com.github.rvesse.airline.types.numerics.DefaultNumericConverter
- tryConvertBigInteger(String, String) - Method in class com.github.rvesse.airline.types.numerics.ComplexNumericTypeConverter
- tryConvertBigInteger(String, String) - Method in class com.github.rvesse.airline.types.numerics.DefaultNumericConverter
- tryConvertByte(String, String) - Method in class com.github.rvesse.airline.types.numerics.ComplexNumericTypeConverter
- tryConvertByte(String, String) - Method in class com.github.rvesse.airline.types.numerics.DefaultNumericConverter
- tryConvertDouble(String, String) - Method in class com.github.rvesse.airline.types.numerics.ComplexNumericTypeConverter
- tryConvertDouble(String, String) - Method in class com.github.rvesse.airline.types.numerics.DefaultNumericConverter
- tryConvertFloat(String, String) - Method in class com.github.rvesse.airline.types.numerics.ComplexNumericTypeConverter
- tryConvertFloat(String, String) - Method in class com.github.rvesse.airline.types.numerics.DefaultNumericConverter
- tryConvertFromString(String, Class<?>, String) - Method in class com.github.rvesse.airline.types.DefaultTypeConverter
-
Tries to convert the value by invoking a static
fromString(String)
method on the type - tryConvertFromValueOf(String, Class<?>, String) - Method in class com.github.rvesse.airline.types.DefaultTypeConverter
-
Tries to convert the value by invoking a static
valueOf(String)
method on the type - tryConvertInteger(String, String) - Method in class com.github.rvesse.airline.types.numerics.ComplexNumericTypeConverter
- tryConvertInteger(String, String) - Method in class com.github.rvesse.airline.types.numerics.DefaultNumericConverter
- tryConvertLong(String, String) - Method in class com.github.rvesse.airline.types.numerics.ComplexNumericTypeConverter
- tryConvertLong(String, String) - Method in class com.github.rvesse.airline.types.numerics.DefaultNumericConverter
- tryConvertNumerics(String, Class<?>, String) - Method in class com.github.rvesse.airline.types.numerics.DefaultNumericConverter
- tryConvertNumerics(String, Class<?>, String) - Method in interface com.github.rvesse.airline.types.numerics.NumericTypeConverter
-
Tries to convert common numeric types
- tryConvertShort(String, String) - Method in class com.github.rvesse.airline.types.numerics.ComplexNumericTypeConverter
- tryConvertShort(String, String) - Method in class com.github.rvesse.airline.types.numerics.DefaultNumericConverter
- tryConvertStringConstructor(String, Class<?>, String) - Method in class com.github.rvesse.airline.types.DefaultTypeConverter
-
Tries to convert the value by invoking a constructor that takes a string on the type
- tryConvertStringMethod(String, Class<?>, String, String) - Method in class com.github.rvesse.airline.types.DefaultTypeConverter
-
Tries to convert the value by invoking a static method on the type
- tryOverrideOptions(Map<Set<String>, OptionMetadata>, Set<String>, OptionMetadata) - Static method in class com.github.rvesse.airline.model.MetadataLoader
- tryParse(GlobalMetadata<T>, Iterable<String>) - Method in class com.github.rvesse.airline.parser.AbstractCommandParser
-
Tries to parse the arguments
- tryParse(GlobalMetadata<T>, String...) - Method in class com.github.rvesse.airline.parser.AbstractCommandParser
-
Tries to parse the arguments
- tryParse(ParserMetadata<T>, CommandMetadata, Iterable<String>) - Method in class com.github.rvesse.airline.parser.AbstractCommandParser
-
Tries to parse the arguments
- type - Variable in class com.github.rvesse.airline.model.CommandMetadata
- type - Variable in class com.github.rvesse.airline.restrictions.common.PositiveNegativeRestriction
- type() - Method in annotation type com.github.rvesse.airline.annotations.Option
-
Is this a command, group or global option
- typeConverter - Variable in class com.github.rvesse.airline.builder.ParserBuilder
- typeConverter - Variable in class com.github.rvesse.airline.model.ParserMetadata
- typeConverter() - Method in annotation type com.github.rvesse.airline.annotations.Parser
-
Sets the type converter class to use
- TypeConverter - Interface in com.github.rvesse.airline.types
-
Interface for type converters
- typeConverterProvider() - Method in annotation type com.github.rvesse.airline.annotations.Arguments
-
Sets an alternative type converter provider for the arguments.
- typeConverterProvider() - Method in annotation type com.github.rvesse.airline.annotations.Option
-
Sets an alternative type converter provider for the option.
- TypeConverterProvider - Interface in com.github.rvesse.airline.types
-
Interface for type converter providers
- typeName - Variable in exception com.github.rvesse.airline.parser.errors.ParseOptionConversionException
U
- underline - Variable in class com.github.rvesse.airline.io.output.ColorizedOutputStream
- underline - Variable in class com.github.rvesse.airline.io.writers.ColorizedWriter
- UNDERLINE - com.github.rvesse.airline.io.decorations.BasicDecoration
- UNDERLINE - Static variable in class com.github.rvesse.airline.io.AnsiControlCodes
- UNDERLINE_OFF - Static variable in class com.github.rvesse.airline.io.AnsiControlCodes
- UNKNOWN - com.github.rvesse.airline.help.sections.HelpFormat
-
Help format is unknown
- unless(ParseState<T>, ArgumentsMetadata) - Method in class com.github.rvesse.airline.restrictions.options.AbstractRequiredUnlessRestriction
-
Answers whether the unless condition of the restriction is met
- unless(ParseState<T>, ArgumentsMetadata) - Method in class com.github.rvesse.airline.restrictions.options.RequiredUnlessEnvironmentRestriction
- unless(ParseState<T>, OptionMetadata) - Method in class com.github.rvesse.airline.restrictions.options.AbstractRequiredUnlessRestriction
-
Answers whether the unless condition of the restriction is met
- unless(ParseState<T>, OptionMetadata) - Method in class com.github.rvesse.airline.restrictions.options.RequiredUnlessEnvironmentRestriction
- unlessDescription() - Method in class com.github.rvesse.airline.restrictions.options.AbstractRequiredUnlessRestriction
-
Provides a description of the unless condition, this will be included in the error messages when this restriction is not met
- unlessDescription() - Method in class com.github.rvesse.airline.restrictions.options.RequiredUnlessEnvironmentRestriction
- unmodifiableListCopy(Iterable<T>) - Static method in class com.github.rvesse.airline.utils.AirlineUtils
- unmodifiableListCopy(Collection<T>) - Static method in class com.github.rvesse.airline.utils.AirlineUtils
- unmodifiableListCopy(T[]) - Static method in class com.github.rvesse.airline.utils.AirlineUtils
- unmodifiableMapCopy(Map<K, V>) - Static method in class com.github.rvesse.airline.utils.AirlineUtils
- unmodifiableSetCopy(Iterable<T>) - Static method in class com.github.rvesse.airline.utils.AirlineUtils
- unmodifiableSetCopy(Set<T>) - Static method in class com.github.rvesse.airline.utils.AirlineUtils
- unparsedInput - Variable in exception com.github.rvesse.airline.parser.errors.ParseArgumentsUnexpectedException
- unparsedInput - Variable in exception com.github.rvesse.airline.parser.errors.ParseCommandUnrecognizedException
- unparsedInput - Variable in class com.github.rvesse.airline.parser.ParseState
- Unrestricted - Annotation Type in com.github.rvesse.airline.annotations.restrictions
-
An annotation that indicates that no restrictions should apply
- url() - Method in annotation type com.github.rvesse.airline.annotations.help.License
-
Gets/Sets a URL for the license
- usage(CommandMetadata, ParserMetadata<T>, OutputStream) - Method in interface com.github.rvesse.airline.help.CommandUsageGenerator
-
Generates the help output to the provided output stream
- usage(CommandMetadata, ParserMetadata<T>, OutputStream) - Method in class com.github.rvesse.airline.help.common.AbstractCommandUsageGenerator
- usage(GlobalMetadata<T>) - Method in class com.github.rvesse.airline.help.common.AbstractGlobalUsageGenerator
- usage(GlobalMetadata<T>) - Method in interface com.github.rvesse.airline.help.GlobalUsageGenerator
-
Generate the help and output it on standard out
- usage(GlobalMetadata<T>, UsagePrinter) - Method in class com.github.rvesse.airline.help.cli.CliGlobalUsageGenerator
- usage(GlobalMetadata<T>, UsagePrinter) - Method in class com.github.rvesse.airline.help.cli.CliGlobalUsageSummaryGenerator
- usage(GlobalMetadata<T>, UsagePrinter) - Method in class com.github.rvesse.airline.help.common.AbstractPrintedGlobalUsageGenerator
-
Generate the help and output is using the provided
UsagePrinter
- usage(GlobalMetadata<T>, UsagePrinter) - Method in class com.github.rvesse.airline.help.markdown.MarkdownGlobalUsageGenerator
- usage(GlobalMetadata<T>, CommandGroupMetadata[]) - Method in interface com.github.rvesse.airline.help.CommandGroupUsageGenerator
-
Generate the help and output it on standard out
- usage(GlobalMetadata<T>, CommandGroupMetadata[]) - Method in class com.github.rvesse.airline.help.common.AbstractCommandGroupUsageGenerator
- usage(GlobalMetadata<T>, CommandGroupMetadata[], UsagePrinter) - Method in class com.github.rvesse.airline.help.cli.CliCommandGroupUsageGenerator
- usage(GlobalMetadata<T>, CommandGroupMetadata[], UsagePrinter) - Method in class com.github.rvesse.airline.help.common.AbstractPrintedCommandGroupUsageGenerator
-
Generate the help and output is using the provided
UsagePrinter
- usage(GlobalMetadata<T>, CommandGroupMetadata[], OutputStream) - Method in interface com.github.rvesse.airline.help.CommandGroupUsageGenerator
-
Generate the help and output it to the stream
- usage(GlobalMetadata<T>, CommandGroupMetadata[], OutputStream) - Method in class com.github.rvesse.airline.help.common.AbstractPrintedCommandGroupUsageGenerator
- usage(GlobalMetadata<T>, OutputStream) - Method in class com.github.rvesse.airline.help.cli.bash.BashCompletionGenerator
- usage(GlobalMetadata<T>, OutputStream) - Method in class com.github.rvesse.airline.help.common.AbstractPrintedGlobalUsageGenerator
- usage(GlobalMetadata<T>, OutputStream) - Method in interface com.github.rvesse.airline.help.GlobalUsageGenerator
-
Generate the help and output it to the stream
- usage(GlobalMetadata<T>, OutputStream) - Method in class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator
- usage(String, String[], String, CommandMetadata, ParserMetadata<T>) - Method in interface com.github.rvesse.airline.help.CommandUsageGenerator
-
Generate the help and output it on standard out
- usage(String, String[], String, CommandMetadata, ParserMetadata<T>) - Method in class com.github.rvesse.airline.help.common.AbstractCommandUsageGenerator
- usage(String, String[], String, CommandMetadata, ParserMetadata<T>, UsagePrinter) - Method in class com.github.rvesse.airline.help.cli.CliCommandUsageGenerator
- usage(String, String[], String, CommandMetadata, ParserMetadata<T>, UsagePrinter) - Method in class com.github.rvesse.airline.help.common.AbstractPrintedCommandUsageGenerator
-
Generate the help and output it using the provided
UsagePrinter
- usage(String, String[], String, CommandMetadata, ParserMetadata<T>, UsagePrinter) - Method in class com.github.rvesse.airline.help.markdown.MarkdownCommandUsageGenerator
- usage(String, String[], String, CommandMetadata, ParserMetadata<T>, OutputStream) - Method in interface com.github.rvesse.airline.help.CommandUsageGenerator
-
Generate the help and output it to the stream
- usage(String, String[], String, CommandMetadata, ParserMetadata<T>, OutputStream) - Method in class com.github.rvesse.airline.help.common.AbstractPrintedCommandUsageGenerator
- usage(String, String[], String, CommandMetadata, ParserMetadata<T>, OutputStream) - Method in class com.github.rvesse.airline.help.html.HtmlCommandUsageGenerator
- usage(String, String[], String, CommandMetadata, ParserMetadata<T>, OutputStream) - Method in class com.github.rvesse.airline.help.man.ManCommandUsageGenerator
- UsageHelper - Class in com.github.rvesse.airline.help
- UsageHelper() - Constructor for class com.github.rvesse.airline.help.UsageHelper
- UsagePrinter - Class in com.github.rvesse.airline.io.printers
-
Helper for printing out usage information
- UsagePrinter(PrintWriter) - Constructor for class com.github.rvesse.airline.io.printers.UsagePrinter
- UsagePrinter(PrintWriter, int) - Constructor for class com.github.rvesse.airline.io.printers.UsagePrinter
- UsagePrinter(PrintWriter, int, int, int, AtomicInteger) - Constructor for class com.github.rvesse.airline.io.printers.UsagePrinter
- useDefaultAliasLocators() - Method in annotation type com.github.rvesse.airline.annotations.Parser
-
Sets whether to use the default user alias locators (default true)
- useDefaultOptionParsers() - Method in annotation type com.github.rvesse.airline.annotations.Parser
-
Sets whether to use the default set of option parsers (default true)
- user - Variable in class com.github.rvesse.airline.examples.modules.CredentialsModule
- USER - com.github.rvesse.airline.annotations.restrictions.PortType
-
The user ports (aka registered ports), these are ports
1024
to49151
and which may be registered and assigned by the IANA - UserAliasedCli - Class in com.github.rvesse.airline.examples.cli.aliases
-
An example of creating a CLI that takes advantage of the aliases feature.
- UserAliasedCli() - Constructor for class com.github.rvesse.airline.examples.cli.aliases.UserAliasedCli
- userAliases - Variable in class com.github.rvesse.airline.model.ParserMetadata
- userAliasesBuilder - Variable in class com.github.rvesse.airline.builder.ParserBuilder
- userAliasesFile() - Method in annotation type com.github.rvesse.airline.annotations.Parser
-
Defines the name of a file from which user defined command aliases should be read
- userAliasesPrefix() - Method in annotation type com.github.rvesse.airline.annotations.Parser
-
Sets the prefix used for properties that define aliases
- userAliasesSearchLocation() - Method in annotation type com.github.rvesse.airline.annotations.Parser
-
Defines the search locations (i.e.
- UserAliasesSource<C> - Class in com.github.rvesse.airline.parser.aliases
-
Represents the source of user defined aliases
- UserAliasesSource(String, String, String...) - Constructor for class com.github.rvesse.airline.parser.aliases.UserAliasesSource
- UserAliasesSource(String, String, List<ResourceLocator>, List<String>) - Constructor for class com.github.rvesse.airline.parser.aliases.UserAliasesSource
- userAliasLocators() - Method in annotation type com.github.rvesse.airline.annotations.Parser
-
Sets the user alias locator classes to be used
- UserAliasSourceBuilder<C> - Class in com.github.rvesse.airline.builder
-
User alias source builder
- UserAliasSourceBuilder(ParserBuilder<C>) - Constructor for class com.github.rvesse.airline.builder.UserAliasSourceBuilder
- usesExtendedColors() - Method in interface com.github.rvesse.airline.io.colors.AnsiColorProvider
-
Gets whether extended colours are used as this will affect the ANSI reset sequence that needs to be used
- usesExtendedColors() - Method in enum com.github.rvesse.airline.io.colors.BasicColor
- usesExtendedColors() - Method in class com.github.rvesse.airline.io.colors.Color256
- usesExtendedColors() - Method in class com.github.rvesse.airline.io.colors.TrueColor
V
- validate(ParseState<T>) - Method in class com.github.rvesse.airline.parser.command.CliParser
-
Validates the parser state
- validate(ParseState<T>) - Method in class com.github.rvesse.airline.restrictions.common.NoOptionLikeValuesRestriction
- validate(ParseState<T>) - Method in class com.github.rvesse.airline.restrictions.global.CommandRequiredRestriction
- validate(ParseState<T>) - Method in class com.github.rvesse.airline.restrictions.global.NoMissingOptionValuesRestriction
- validate(ParseState<T>) - Method in class com.github.rvesse.airline.restrictions.global.NoUnexpectedArgumentsRestriction
- validate(ParseState<T>) - Method in interface com.github.rvesse.airline.restrictions.GlobalRestriction
-
Validates the parser state
- validate(ParseState<T>) - Method in class com.github.rvesse.airline.restrictions.None
- validate(ParseState<T>, String, Object) - Method in class com.github.rvesse.airline.examples.userguide.restrictions.custom.MultipleOfRestriction
- validate(ParseState<T>, List<GlobalRestriction>) - Method in class com.github.rvesse.airline.parser.command.SingleCommandParser
-
Validates the parser state
- validate(String, String) - Method in class com.github.rvesse.airline.restrictions.common.PathRestriction
- value - Variable in exception com.github.rvesse.airline.parser.errors.ParseOptionConversionException
- value - Variable in class com.github.rvesse.airline.types.ConvertResult
- value - Variable in class com.github.rvesse.airline.types.numerics.NumericCandidate
- value - Variable in class com.github.rvesse.airline.utils.predicates.LocaleSensitiveStringFinder
- value() - Method in annotation type com.github.rvesse.airline.annotations.Groups
- value() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.AllowedEnumValues
-
Sets the enum type from whose values the allowed values are taken
- value() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.Partials
-
Specifies the partial modifiers for restrictions
- value() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.PortRanges
-
Sets the valid port ranges
- value() - Method in annotation type com.github.rvesse.airline.examples.userguide.restrictions.custom.MultipleOf
-
The value that we must be a multiple of
- ValueMatcher<TOption> - Class in com.github.rvesse.airline.prompts.matchers
-
An option matcher that matches based on actual value rather than strings
- ValueMatcher(Class<TOption>) - Constructor for class com.github.rvesse.airline.prompts.matchers.ValueMatcher
-
Creates a new value matcher
- valueOf(String) - Static method in enum com.github.rvesse.airline.annotations.OptionType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.github.rvesse.airline.annotations.restrictions.PathKind
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.github.rvesse.airline.annotations.restrictions.PortType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.github.rvesse.airline.Context
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.github.rvesse.airline.examples.cli.aliases.Logs.Format
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.github.rvesse.airline.examples.sendit.PostalService
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.github.rvesse.airline.help.cli.bash.CompletionBehaviour
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.github.rvesse.airline.help.sections.HelpFormat
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.github.rvesse.airline.io.colors.BasicColor
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.github.rvesse.airline.io.decorations.BasicDecoration
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.github.rvesse.airline.io.printers.TroffPrinter.BulletStyle
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.github.rvesse.airline.io.printers.TroffPrinter.ListType
-
Returns the enum constant of this type with the specified name.
- values - Variable in class com.github.rvesse.airline.examples.io.ColorsTrue
- values() - Static method in enum com.github.rvesse.airline.annotations.OptionType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.github.rvesse.airline.annotations.restrictions.PathKind
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.github.rvesse.airline.annotations.restrictions.PortType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.github.rvesse.airline.Context
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.github.rvesse.airline.examples.cli.aliases.Logs.Format
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.github.rvesse.airline.examples.sendit.PostalService
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.github.rvesse.airline.help.cli.bash.CompletionBehaviour
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.github.rvesse.airline.help.sections.HelpFormat
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.github.rvesse.airline.io.colors.BasicColor
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.github.rvesse.airline.io.decorations.BasicDecoration
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.github.rvesse.airline.io.printers.TroffPrinter.BulletStyle
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.github.rvesse.airline.io.printers.TroffPrinter.ListType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- variables - Variable in class com.github.rvesse.airline.restrictions.options.RequiredUnlessEnvironmentRestriction
- variables() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.RequiredUnlessEnvironment
-
Specifies the name(s) of the environment variable that when present renders the option not required
- verbose - Variable in class com.github.rvesse.airline.examples.inheritance.BaseCommand
- verbosity - Variable in class com.github.rvesse.airline.examples.modules.ModuleReuse
-
A field marked with
AirlineModule
will also be scanned for options - verbosity - Variable in class com.github.rvesse.airline.examples.modules.Modules
-
A field marked with
AirlineModule
will also be scanned for options - verbosity - Variable in class com.github.rvesse.airline.examples.modules.VerbosityModule
- VerbosityModule - Class in com.github.rvesse.airline.examples.modules
- VerbosityModule() - Constructor for class com.github.rvesse.airline.examples.modules.VerbosityModule
- version - Variable in class com.github.rvesse.airline.help.sections.common.VersionSection.VersionInfo
- Version - Annotation Type in com.github.rvesse.airline.annotations.help
- VersionInfo() - Constructor for class com.github.rvesse.airline.help.sections.common.VersionSection.VersionInfo
- versionProperty() - Method in annotation type com.github.rvesse.airline.annotations.help.Version
-
Sets the property used to find version information (if any)
- versions - Variable in class com.github.rvesse.airline.help.sections.common.VersionSection
- VersionSection - Class in com.github.rvesse.airline.help.sections.common
- VersionSection(String[], ResourceLocator[], String, String, String, String, String[], String[], boolean, boolean) - Constructor for class com.github.rvesse.airline.help.sections.common.VersionSection
- VersionSection.VersionInfo - Class in com.github.rvesse.airline.help.sections.common
- violated(ParseState<T>, ArgumentsMetadata, String) - Method in class com.github.rvesse.airline.restrictions.common.AbstractStringRestriction
-
Method that derived classes must implement to provide an exception for the case of an invalid argument value, this will be called if
AbstractStringRestriction.isValid(String)
returnsfalse
- violated(ParseState<T>, ArgumentsMetadata, String) - Method in class com.github.rvesse.airline.restrictions.common.EndsWithRestriction
- violated(ParseState<T>, ArgumentsMetadata, String) - Method in class com.github.rvesse.airline.restrictions.common.LengthRestriction
- violated(ParseState<T>, ArgumentsMetadata, String) - Method in class com.github.rvesse.airline.restrictions.common.NoOptionLikeValuesRestriction
- violated(ParseState<T>, ArgumentsMetadata, String) - Method in class com.github.rvesse.airline.restrictions.common.NotBlankRestriction
- violated(ParseState<T>, ArgumentsMetadata, String) - Method in class com.github.rvesse.airline.restrictions.common.NotEmptyRestriction
- violated(ParseState<T>, ArgumentsMetadata, String) - Method in class com.github.rvesse.airline.restrictions.common.StartsWithRestriction
- violated(ParseState<T>, OptionMetadata, String) - Method in class com.github.rvesse.airline.restrictions.common.AbstractStringRestriction
-
Method that derived classes must implement to provide an exception for the case of an invalid option value, this will be called if
AbstractStringRestriction.isValid(String)
returnsfalse
- violated(ParseState<T>, OptionMetadata, String) - Method in class com.github.rvesse.airline.restrictions.common.EndsWithRestriction
- violated(ParseState<T>, OptionMetadata, String) - Method in class com.github.rvesse.airline.restrictions.common.LengthRestriction
- violated(ParseState<T>, OptionMetadata, String) - Method in class com.github.rvesse.airline.restrictions.common.NoOptionLikeValuesRestriction
- violated(ParseState<T>, OptionMetadata, String) - Method in class com.github.rvesse.airline.restrictions.common.NotBlankRestriction
- violated(ParseState<T>, OptionMetadata, String) - Method in class com.github.rvesse.airline.restrictions.common.NotEmptyRestriction
- violated(ParseState<T>, OptionMetadata, String) - Method in class com.github.rvesse.airline.restrictions.common.StartsWithRestriction
W
- waitForPromptResponse(Future<T>) - Method in class com.github.rvesse.airline.prompts.Prompt
-
Wait for a prompt response
- wasSuccessful() - Method in class com.github.rvesse.airline.parser.ParseResult
-
Indicates whether parsing was successful
- wasSuccessful() - Method in class com.github.rvesse.airline.types.ConvertResult
-
Whether the conversion was successful
- wasSuccessfull() - Method in class com.github.rvesse.airline.types.ConvertResult
-
Deprecated.Use correctly spelled overload
ConvertResult.wasSuccessful()
instead - weight - Variable in class com.github.rvesse.airline.examples.sendit.Package
- WHITE - com.github.rvesse.airline.io.colors.BasicColor
- width - Variable in class com.github.rvesse.airline.examples.sendit.Package
- withAlias(String) - Method in class com.github.rvesse.airline.builder.ParserBuilder
-
Adds an alias
- withAliasesChaining() - Method in class com.github.rvesse.airline.builder.ParserBuilder
-
Sets that aliases may be defined in terms of other aliases
- withAliasesOverridingBuiltIns() - Method in class com.github.rvesse.airline.builder.ParserBuilder
-
Sets that aliases should override built-in commands
- withAliasForceBuiltInPrefix(char) - Method in class com.github.rvesse.airline.builder.ParserBuilder
-
Sets a prefix character used in alias definitions to force use of a built-in as opposed to a chained alias
- withArgument(ArgumentsMetadata, String) - Method in class com.github.rvesse.airline.parser.ParseState
- withArgument(String) - Method in class com.github.rvesse.airline.builder.AliasBuilder
-
Sets an argument for the alias
- withArguments(String...) - Method in class com.github.rvesse.airline.builder.AliasBuilder
-
Sets arguments for the alias
- withArgumentsSeparator(String) - Method in class com.github.rvesse.airline.builder.ParserBuilder
-
Sets the arguments separator, this is a token used to indicate the point at which no further options will be seen and all further tokens should be treated as arguments.
- withColumns(int) - Method in class com.github.rvesse.airline.prompts.builders.ListFormatBuilder
-
Specifies the desired number of columns for the listed options
- withCommand(CommandMetadata) - Method in class com.github.rvesse.airline.parser.ParseState
- withCommand(Class<? extends C>) - Method in class com.github.rvesse.airline.builder.CliBuilder
- withCommand(Class<? extends C>) - Method in class com.github.rvesse.airline.builder.GroupBuilder
- withCommandAbbreviation() - Method in class com.github.rvesse.airline.builder.ParserBuilder
-
Sets that command abbreviation is enabled
- withCommandFactory(CommandFactory<C>) - Method in class com.github.rvesse.airline.builder.ParserBuilder
-
Specifies the command factory to use
- withCommands(Class<? extends C>, Class<? extends C>...) - Method in class com.github.rvesse.airline.builder.CliBuilder
- withCommands(Class<? extends C>, Class<? extends C>...) - Method in class com.github.rvesse.airline.builder.GroupBuilder
- withCommands(Iterable<Class<? extends C>>) - Method in class com.github.rvesse.airline.builder.CliBuilder
- withCommands(Iterable<Class<? extends C>>) - Method in class com.github.rvesse.airline.builder.GroupBuilder
- withCompositionAnnotations(String...) - Method in class com.github.rvesse.airline.builder.ParserBuilder
- withCompositionAnnotations(Collection<String>) - Method in class com.github.rvesse.airline.builder.ParserBuilder
-
Specifies the class names of annotations that Airline should consider to mark a field for further inspection and injection to enable composition.
- withConfiguration(ParserMetadata<T>) - Method in class com.github.rvesse.airline.parser.ParseState
- withDebugging - Variable in class com.github.rvesse.airline.help.cli.bash.BashCompletionGenerator
- withDefaultColumns() - Method in class com.github.rvesse.airline.prompts.builders.ListFormatBuilder
-
Specifies that the default number of columns (see
ListFormatBuilder.DEFAULT_COLUMNS
) will be used - withDefaultCommand(Class<? extends C>) - Method in class com.github.rvesse.airline.builder.CliBuilder
- withDefaultCommand(Class<? extends C>) - Method in class com.github.rvesse.airline.builder.GroupBuilder
- withDefaultCommandFactory() - Method in class com.github.rvesse.airline.builder.ParserBuilder
-
Specifies that the default command factory should be used
- withDefaultCompositionAnnotations() - Method in class com.github.rvesse.airline.builder.ParserBuilder
-
Configures the parser to use the default set of composition annotations.
- withDefaultErrorHandler() - Method in class com.github.rvesse.airline.builder.ParserBuilder
-
Sets that the default error handler should be used
- withDefaultFormatter() - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder
-
Specifies that the default formatter should be used, this is the list formatter
- withDefaultLocators() - Method in class com.github.rvesse.airline.builder.UserAliasSourceBuilder
- withDefaultNumericTypeConverter() - Method in class com.github.rvesse.airline.builder.ParserBuilder
-
Indicates that default numeric type conversion should be used
- withDefaultOptionMatcher() - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder
-
Specifies that the default option matcher be used
- withDefaultOptionParsers() - Method in class com.github.rvesse.airline.builder.ParserBuilder
-
Configures the CLI to use the default set of option parsers in addition to any previously registered
- withDefaultPromptProvider() - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder
-
Specifies that the default prompt provider should be used
- withDefaultRestrictions() - Method in class com.github.rvesse.airline.builder.CliBuilder
- withDefaultSearchLocation(String) - Method in class com.github.rvesse.airline.builder.UserAliasSourceBuilder
- withDefaultTypeConverter() - Method in class com.github.rvesse.airline.builder.ParserBuilder
-
Sets that the default type converter should be used
- withDefaultTypeConverter() - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder
-
Specifies that the default type converter be used
- withDescription(String) - Method in class com.github.rvesse.airline.builder.CliBuilder
- withDescription(String) - Method in class com.github.rvesse.airline.builder.GroupBuilder
-
Sets the description for the group
- withErrorHandler(ParserErrorHandler) - Method in class com.github.rvesse.airline.builder.ParserBuilder
-
Sets the error handler to use
- withFilename(String) - Method in class com.github.rvesse.airline.builder.UserAliasSourceBuilder
- withFlagNegationPrefix(String) - Method in class com.github.rvesse.airline.builder.ParserBuilder
-
Sets the flag negation prefix, this is used to determine whether to set a flag option (a zero arity option) to
false
rather than the usual behaviour of setting it totrue
. - withFormatBuilder() - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder
-
Switches to a child builder for the prompt format
- withFormatBuilder(PromptFormatBuilder<TOption>) - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder
-
Specifies the prompt formatter builder to use
- withFormatter(PromptFormatter) - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder
-
Specifies the prompt formatter to use
- withGlobal(GlobalMetadata<T>) - Method in class com.github.rvesse.airline.parser.ParseState
- withGroup(CommandGroupMetadata) - Method in class com.github.rvesse.airline.parser.ParseState
- withGroup(String) - Method in class com.github.rvesse.airline.builder.CliBuilder
- withHelpSection(HelpSection) - Method in class com.github.rvesse.airline.builder.CliBuilder
- withHiddenState(boolean) - Method in class com.github.rvesse.airline.builder.GroupBuilder
- withListFormatBuilder() - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder
-
Switches to a child builder for the list formatter
- withListFormatter() - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder
-
Specifies that a list formatter should be used
- withLocator(ResourceLocator) - Method in class com.github.rvesse.airline.builder.UserAliasSourceBuilder
- withLocators(ResourceLocator...) - Method in class com.github.rvesse.airline.builder.UserAliasSourceBuilder
- withLocators(List<ResourceLocator>) - Method in class com.github.rvesse.airline.builder.UserAliasSourceBuilder
- withName(String) - Method in class com.github.rvesse.airline.builder.AliasBuilder
-
Sets the name for the alias
- withNoRestrictions() - Method in class com.github.rvesse.airline.builder.CliBuilder
- withNumericOptionSelection() - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder
-
Enables numeric option selection
- withNumericTypeConverter(NumericTypeConverter) - Method in class com.github.rvesse.airline.builder.ParserBuilder
-
Indicates the desired numeric type converter to use, this is passed as an argument to the given type converter
- withOnlyDefaultOptionParsers() - Method in class com.github.rvesse.airline.builder.ParserBuilder
-
Configures the CLI to use only the default set of option parsers
- withOnlyDefaultRestrictions() - Method in class com.github.rvesse.airline.builder.CliBuilder
- withOption(OptionMetadata) - Method in class com.github.rvesse.airline.parser.ParseState
- withOption(TOption) - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder
-
Specifies an option for the prompt
- withOptionAbbreviation() - Method in class com.github.rvesse.airline.builder.ParserBuilder
-
Sets that option abbreviation is enabled
- withOptionMatcher(PromptOptionMatcher<TOption>) - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder
-
Specifies the option matcher to use
- withOptionParser(OptionParser<C>) - Method in class com.github.rvesse.airline.builder.ParserBuilder
-
Configures the CLI to use the given option parser
- withOptionParsers(OptionParser<C>...) - Method in class com.github.rvesse.airline.builder.ParserBuilder
-
Configures the CLI to use the given option parsers
- withOptions(TOption...) - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder
-
Specifies one/more options for the prompt
- withOptionValue(OptionMetadata, String) - Method in class com.github.rvesse.airline.parser.ParseState
- withoutNumericOptionSelection() - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder
-
Disables numeric option selection
- withoutTimeout() - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder
-
Specifies that no timeout should be used
- withParser() - Method in class com.github.rvesse.airline.builder.CliBuilder
- withPrefix(String) - Method in class com.github.rvesse.airline.builder.UserAliasSourceBuilder
- withProgramName(String) - Method in class com.github.rvesse.airline.builder.UserAliasSourceBuilder
- withPromptMessage(String) - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder
-
Specifies the prompt message to display
- withPromptProvider(PromptProvider) - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder
-
Specifies that the given prompt provider should be used
- withQuestionFormatter() - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder
-
Specifies that a question formatter should be used
- withRestriction(GlobalRestriction) - Method in class com.github.rvesse.airline.builder.CliBuilder
- withRestrictions(GlobalRestriction...) - Method in class com.github.rvesse.airline.builder.CliBuilder
- withSearchLocation(String) - Method in class com.github.rvesse.airline.builder.UserAliasSourceBuilder
- withSearchLocations(String...) - Method in class com.github.rvesse.airline.builder.UserAliasSourceBuilder
- withSubGroup(String) - Method in class com.github.rvesse.airline.builder.GroupBuilder
- withTimeout(long) - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder
-
Specifies the timeout
- withTimeout(long, TimeUnit) - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder
-
Specifies the timeout
- withTimeoutUnit(TimeUnit) - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder
-
Specifies the time unit used to apply timeouts to prompts
- withTypeConverter(TypeConverter) - Method in class com.github.rvesse.airline.builder.ParserBuilder
-
Sets the type converter for the parser
- withTypeConverter(TypeConverter) - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder
-
Specifies the type converter to use
- withUnparsedInput(String) - Method in class com.github.rvesse.airline.parser.ParseState
- withUserAliases() - Method in class com.github.rvesse.airline.builder.ParserBuilder
-
Gets a builder that provides detailed control over building user aliases
- withUserAliases(String) - Method in class com.github.rvesse.airline.builder.ParserBuilder
-
Deprecated.Use
ParserBuilder.withUserAliases()
to access the user alias builder directly instead - withUserAliases(String, String) - Method in class com.github.rvesse.airline.builder.ParserBuilder
-
Deprecated.Use
ParserBuilder.withUserAliases()
to access the user alias builder directly instead - withUserAliases(String, String, String...) - Method in class com.github.rvesse.airline.builder.ParserBuilder
-
Deprecated.Use
ParserBuilder.withUserAliases()
to access the user alias builder directly instead - withUserAliases(String, String, List<ResourceLocator>, String...) - Method in class com.github.rvesse.airline.builder.ParserBuilder
-
Deprecated.Use
ParserBuilder.withUserAliases()
to access the user alias builder directly instead - WorkingDirectoryLocator - Class in com.github.rvesse.airline.parser.resources
-
A user alias locator that allows the
./
or.\
alias (depending on your platforms file separator) to be used to refer to the current working directory - WorkingDirectoryLocator() - Constructor for class com.github.rvesse.airline.parser.resources.WorkingDirectoryLocator
- writable - Variable in class com.github.rvesse.airline.restrictions.common.PathRestriction
- writable() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.Directory
-
Gets/Sets whether the given directory must be writable
- writable() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.File
-
Gets/Sets whether the given file must be writable
- writable() - Method in annotation type com.github.rvesse.airline.annotations.restrictions.Path
-
Gets/Sets whether the given file must be writable
- write(byte[]) - Method in class com.github.rvesse.airline.io.output.AnsiOutputStream
- write(byte[], int, int) - Method in class com.github.rvesse.airline.io.output.AnsiOutputStream
- write(char[], int, int) - Method in class com.github.rvesse.airline.io.writers.AnsiWriter
- write(int) - Method in class com.github.rvesse.airline.io.output.AnsiOutputStream
- write(int) - Method in class com.github.rvesse.airline.io.writers.AnsiWriter
- write(String, int, int) - Method in class com.github.rvesse.airline.io.writers.AnsiWriter
- writeCommandCase(Writer, GlobalMetadata<T>, CommandGroupMetadata, CommandMetadata, int, boolean) - Method in class com.github.rvesse.airline.help.cli.bash.BashCompletionGenerator
- writeCommandFunctionCall(Writer, GlobalMetadata<T>, CommandGroupMetadata, CommandMetadata, int) - Method in class com.github.rvesse.airline.help.cli.bash.BashCompletionGenerator
- writeCommandFunctionName(Writer, GlobalMetadata<T>, CommandGroupMetadata, CommandMetadata, boolean) - Method in class com.github.rvesse.airline.help.cli.bash.BashCompletionGenerator
- writeCompletionGeneration(Writer, int, boolean, BashCompletion, String...) - Method in class com.github.rvesse.airline.help.cli.bash.BashCompletionGenerator
- writeFunctionName(Writer, GlobalMetadata<T>, boolean) - Method in class com.github.rvesse.airline.help.cli.bash.BashCompletionGenerator
- writeGroupCase(Writer, GlobalMetadata<T>, CommandGroupMetadata, int) - Method in class com.github.rvesse.airline.help.cli.bash.BashCompletionGenerator
- writeGroupFunctionCall(Writer, GlobalMetadata<T>, CommandGroupMetadata, int) - Method in class com.github.rvesse.airline.help.cli.bash.BashCompletionGenerator
- writeGroupFunctionName(Writer, GlobalMetadata<T>, CommandGroupMetadata, boolean) - Method in class com.github.rvesse.airline.help.cli.bash.BashCompletionGenerator
- writeHeader(Writer) - Method in class com.github.rvesse.airline.help.cli.bash.BashCompletionGenerator
- writeHelperFunctions(Writer) - Method in class com.github.rvesse.airline.help.cli.bash.BashCompletionGenerator
- writer - Variable in class com.github.rvesse.airline.io.printers.TroffPrinter
- writer - Variable in class com.github.rvesse.airline.io.writers.WriterControlTracker
- writer - Variable in class com.github.rvesse.airline.prompts.console.StreamPrompt
- WriterControlTracker<T> - Class in com.github.rvesse.airline.io.writers
- WriterControlTracker(Writer, ControlCodeSource<T>) - Constructor for class com.github.rvesse.airline.io.writers.WriterControlTracker
- writeWordListVariable(Writer, int, String, Iterator<String>) - Method in class com.github.rvesse.airline.help.cli.bash.BashCompletionGenerator
X
- Xml - com.github.rvesse.airline.examples.cli.aliases.Logs.Format
Y
- YELLOW - com.github.rvesse.airline.io.colors.BasicColor
- YourInterface - Interface in com.github.rvesse.airline.examples.help
All Classes All Packages