A B C D E F G H I K L M N O P R S T U V W 

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
 
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
 
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 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
 
AbstractCommandUsageGenerator(Comparator<? super HelpHint>, Comparator<? super OptionMetadata>, Comparator<? super Map.Entry<Integer, String>>, 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 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
 
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
 
AbstractNameValueOptionParser(char) - Constructor for class com.github.rvesse.airline.parser.options.AbstractNameValueOptionParser
 
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
 
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
 
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
 
Accessor - Class in com.github.rvesse.airline
 
Accessor(Field...) - Constructor for class com.github.rvesse.airline.Accessor
 
Accessor(Iterable<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
 
addArgumentsRestriction(Class<? extends Annotation>, ArgumentsRestrictionFactory) - Static method in class com.github.rvesse.airline.restrictions.factories.RestrictionRegistry
 
addCommand(CommandMetadata) - Method in class com.github.rvesse.airline.model.CommandGroupMetadata
Adds a command to the group
addFactory(Class<? extends Annotation>, HelpSectionFactory) - Static method in class com.github.rvesse.airline.help.sections.factories.HelpSectionRegistry
 
addGlobalRestriction(Class<? extends Annotation>, GlobalRestrictionFactory) - Static method in class com.github.rvesse.airline.restrictions.factories.RestrictionRegistry
 
addOptionRestriction(Class<? extends Annotation>, OptionRestrictionFactory) - Static method in class com.github.rvesse.airline.restrictions.factories.RestrictionRegistry
 
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
 
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
 
AliasBuilder<C> - Class in com.github.rvesse.airline.builder
 
AliasBuilder(String) - Constructor for class com.github.rvesse.airline.builder.AliasBuilder
 
aliases - Variable in class com.github.rvesse.airline.builder.ParserBuilder
 
aliasesMayChain - Variable in class com.github.rvesse.airline.builder.ParserBuilder
 
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() - 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
 
AliasMetadata(String, List<String>) - Constructor for class com.github.rvesse.airline.model.AliasMetadata
 
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
 
allowAbbreviatedOptions - Variable in class com.github.rvesse.airline.builder.ParserBuilder
 
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 - 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
 
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
applyAliases(PeekingIterator<String>, ParseState<T>) - Method in class com.github.rvesse.airline.parser.AbstractCommandParser
 
argsSeparator - Variable in class com.github.rvesse.airline.builder.ParserBuilder
 
Arguments - Annotation Type in com.github.rvesse.airline.annotations
 
arguments - Variable in class com.github.rvesse.airline.help.suggester.SuggestCommand
 
ArgumentsMetadata - Class in com.github.rvesse.airline.model
 
ArgumentsMetadata(Iterable<String>, String, Iterable<ArgumentsRestriction>, TypeConverterProvider, Iterable<Field>) - Constructor for class com.github.rvesse.airline.model.ArgumentsMetadata
 
ArgumentsMetadata(Iterable<ArgumentsMetadata>) - Constructor for class com.github.rvesse.airline.model.ArgumentsMetadata
 
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
arrayToList(T[]) - Static method in class com.github.rvesse.airline.utils.AirlineUtils
 
asObjects(Set<String>) - Static method in class com.github.rvesse.airline.restrictions.common.AbstractAllowedValuesRestriction
 

B

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
 
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
 
build() - Method in class com.github.rvesse.airline.builder.AbstractBuilder
Builds the type
build() - Method in class com.github.rvesse.airline.builder.AliasBuilder
 
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
 
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
 
buildSuffixes(long, String[][]) - Static method in class com.github.rvesse.airline.types.numerics.abbreviated.MultiSequenceAbbreviatedNumericTypeConverter
 
buildSuffixes(long, String...) - Static method in class com.github.rvesse.airline.types.numerics.abbreviated.SequenceAbbreviatedNumericTypeConverter
 
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

C

calculateMaxRows(HelpHint) - Static method in class com.github.rvesse.airline.help.cli.CliUsageHelper
 
call() - Method in class com.github.rvesse.airline.help.Help
 
call() - Method in class com.github.rvesse.airline.help.suggester.SuggestCommand
 
checkArguments(String, Class<?>, String) - Static method in class com.github.rvesse.airline.types.DefaultTypeConverter
Checks that the arguments are all non-null
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
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
ClassicGetOptParser() - Constructor for class com.github.rvesse.airline.parser.options.ClassicGetOptParser
 
Cli - Annotation Type in com.github.rvesse.airline.annotations
Class annotation used to declaratively specify a CLI
Cli<C> - Class in com.github.rvesse.airline
Class for encapsulating and parsing CLIs
Cli(Class<?>) - Constructor for class com.github.rvesse.airline.Cli
Creates a new CLI from a class annotated with the Cli annotation
Cli(GlobalMetadata<C>) - Constructor for class com.github.rvesse.airline.Cli
Creates a new CLI
Cli.NO_DEFAULT - Class in com.github.rvesse.airline.annotations
 
Cli.NO_DEFAULT() - Constructor for class com.github.rvesse.airline.annotations.Cli.NO_DEFAULT
 
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
 
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
 
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.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.help - package com.github.rvesse.airline.help
 
com.github.rvesse.airline.help.cli - package com.github.rvesse.airline.help.cli
 
com.github.rvesse.airline.help.common - package com.github.rvesse.airline.help.common
 
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.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.suggester - package com.github.rvesse.airline.parser.suggester
 
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 - Annotation Type in com.github.rvesse.airline.annotations
Marks a class as a command
command - Variable in class com.github.rvesse.airline.help.Help
 
command - Variable in class com.github.rvesse.airline.help.suggester.CommandSuggester
 
commandFactory - Variable in class com.github.rvesse.airline.builder.ParserBuilder
 
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
 
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
 
CommandGroupUsageGenerator<T> - Interface in com.github.rvesse.airline.help
Interface implemented by classes that can generate usage documentation for a command group
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
 
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
 
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 - 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
 
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
 
compare(Object, Object) - Method in class com.github.rvesse.airline.utils.comparators.AbstractObjectComparator
 
compare(HelpSection, HelpSection) - Method in class com.github.rvesse.airline.utils.comparators.HelpSectionComparator
 
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
 
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
 
compareValues(String, String) - Method in class com.github.rvesse.airline.utils.comparators.LexicalComparator
 
ComplexNumericTypeConverter - Class in com.github.rvesse.airline.types.numerics
Abstract numeric type converter that supports numerics given in the form 1234suffix where suffix denotes some multiplier.
ComplexNumericTypeConverter() - Constructor for class com.github.rvesse.airline.types.numerics.ComplexNumericTypeConverter
 
contains(PortType) - Method in enum com.github.rvesse.airline.annotations.restrictions.PortType
Gets whether the port type contains another port type i.e.
Context - Enum in com.github.rvesse.airline
 
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
ConvertResult - Class in com.github.rvesse.airline.types
Helper class used to represent the result of an attempted conversion.
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
 
Copyright - Annotation Type in com.github.rvesse.airline.annotations.help
Annotation that provides a copyright statement in a commands help
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.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.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
 
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(Port) - Method in class com.github.rvesse.airline.restrictions.factories.PortRestrictionFactory
 
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.StringRestrictionFactory
 
createDoubleRange(Annotation) - Method in class com.github.rvesse.airline.restrictions.factories.RangeRestrictionFactory
 
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
 
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
 
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<T>) - 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>) - 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
 
createIntegerRange(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.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
 
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

D

DEFAULT_ARGUMENTS_SEPARATOR - Static variable in class com.github.rvesse.airline.model.ParserMetadata
Default separator used to separate arguments from options
DEFAULT_COLUMNS - Static variable in class com.github.rvesse.airline.help.common.AbstractUsageGenerator
 
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_HINT_COMPARATOR - Static variable in class com.github.rvesse.airline.help.UsageHelper
Default comparator for help hints
DEFAULT_OPTION_COMPARATOR - Static variable in class com.github.rvesse.airline.help.UsageHelper
Default comparator for options
defaultCommand - Variable in class com.github.rvesse.airline.builder.CliBuilder
 
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
 
DefaultNumericConverter - Class in com.github.rvesse.airline.types.numerics
 
DefaultNumericConverter() - Constructor for class com.github.rvesse.airline.types.numerics.DefaultNumericConverter
 
DefaultOption - Annotation Type in com.github.rvesse.airline.annotations
Annotation to mark a field as the default option
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 the ParserMetadata provided by the parse state
DefaultTypeConverterProvider() - Constructor for class com.github.rvesse.airline.types.DefaultTypeConverterProvider
 
description - Variable in class com.github.rvesse.airline.builder.CliBuilder
 
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
 
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

E

equals(Object) - Method in class com.github.rvesse.airline.Accessor
 
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
 
errorHandler - Variable in class com.github.rvesse.airline.builder.ParserBuilder
 
errors - Variable in class com.github.rvesse.airline.parser.errors.handlers.AbstractCollectingHandler
 
evaluate(T) - Method in class com.github.rvesse.airline.utils.predicates.AbstractAbbreviationFinder
 
evaluate(String) - Method in class com.github.rvesse.airline.utils.predicates.LocaleSensitiveStringFinder
 
evaluate(AliasMetadata) - Method in class com.github.rvesse.airline.utils.predicates.parser.AliasFinder
 
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(CommandGroupMetadata) - Method in class com.github.rvesse.airline.utils.predicates.parser.GroupFinder
 
evaluate(OptionMetadata) - Method in class com.github.rvesse.airline.utils.predicates.parser.OptionFinder
 
evaluate(Pair<OptionMetadata, Object>) - Method in class com.github.rvesse.airline.utils.predicates.parser.ParsedOptionFinder
 
evaluate(OptionMetadata) - Method in class com.github.rvesse.airline.utils.predicates.restrictions.AbstractOptionRestrictionBasedFinder
 
evaluate(Pair<OptionMetadata, Object>) - Method in class com.github.rvesse.airline.utils.predicates.restrictions.AbstractParsedOptionRestrictionBasedFinder
 
evaluate(OptionRestriction) - Method in class com.github.rvesse.airline.utils.predicates.restrictions.AllowedValuesOptionFinder
 
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.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
 
Examples - Annotation Type in com.github.rvesse.airline.annotations.help
Annotation that provides an examples section for a commands help
ExamplesSection - Class in com.github.rvesse.airline.help.sections.common
 
ExamplesSection(String[], String[]) - Constructor for class com.github.rvesse.airline.help.sections.common.ExamplesSection
 
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
 

F

FailAll - Class in com.github.rvesse.airline.parser.errors.handlers
 
FailAll() - Constructor for class com.github.rvesse.airline.parser.errors.handlers.FailAll
 
FailFast - Class in com.github.rvesse.airline.parser.errors.handlers
 
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
finalValidate(ParseState<T>, OptionMetadata) - Method in class com.github.rvesse.airline.restrictions.AbstractCommonRestriction
 
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>, OptionMetadata) - Method in class com.github.rvesse.airline.restrictions.common.IsRequiredRestriction
 
finalValidate(ParseState<T>, ArgumentsMetadata) - 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>, ArgumentsMetadata) - 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.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
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
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(Iterator<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>, T) - Static method in class com.github.rvesse.airline.utils.AirlineUtils
 
flagNegationPrefix - Variable in class com.github.rvesse.airline.builder.ParserBuilder
 
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

G

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
 
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
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
 
getArguments() - Method in class com.github.rvesse.airline.model.AliasMetadata
 
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(ParseState<T>, ArgumentsMetadata) - Static method in class com.github.rvesse.airline.restrictions.AbstractCommonRestriction
 
getArgumentTitle(ArgumentsMetadata, int) - Static method in class com.github.rvesse.airline.restrictions.AbstractCommonRestriction
 
getArity() - Method in class com.github.rvesse.airline.model.OptionMetadata
 
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
 
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
 
getCommandMetadata() - Method in class com.github.rvesse.airline.SingleCommand
Gets the command metadata
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
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.LengthRestriction
 
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.RangeRestriction
 
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.RequireFromRestriction
 
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
 
getDefaultGroupCommands() - Method in class com.github.rvesse.airline.model.GlobalMetadata
 
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
 
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
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.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.LengthRestriction
 
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.RangeRestriction
 
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.RequireFromRestriction
 
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
 
getGroup(String) - Method in class com.github.rvesse.airline.builder.CliBuilder
 
getGroup() - Method in class com.github.rvesse.airline.parser.ParseState
 
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
 
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
 
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
 
getLong(NumericCandidate) - Method in class com.github.rvesse.airline.types.numerics.ComplexNumericTypeConverter
 
getMaximumPort() - Method in enum com.github.rvesse.airline.annotations.restrictions.PortType
Gets the maximum port
getMaximumValue() - Method in exception com.github.rvesse.airline.parser.errors.ParseOptionOutOfRangeException
 
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
Gets the minimum port
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(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
 
getMultiplier(NumericCandidate) - Method in class com.github.rvesse.airline.types.numerics.ComplexNumericTypeConverter
 
getName() - Method in class com.github.rvesse.airline.Accessor
 
getName() - Method in class com.github.rvesse.airline.model.AliasMetadata
 
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
 
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
 
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
 
getOptions() - Method in class com.github.rvesse.airline.model.OptionMetadata
 
getOptions() - Method in exception com.github.rvesse.airline.parser.errors.ParseOptionGroupException
 
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 title
getOptionTitle() - Method in exception com.github.rvesse.airline.parser.errors.ParseOptionMissingException
 
getOptionTitle() - Method in exception com.github.rvesse.airline.parser.errors.ParseOptionMissingValueException
 
getOptionType() - Method in class com.github.rvesse.airline.model.OptionMetadata
 
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
 
getParserConfiguration() - Method in class com.github.rvesse.airline.parser.ParseState
 
getParserConfiguration() - Method in class com.github.rvesse.airline.SingleCommand
Gets the parser configuration
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.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.LengthRestriction
 
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.RangeRestriction
 
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.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
 
getRadix(NumericCandidate) - Method in class com.github.rvesse.airline.types.numerics.abbreviated.AbbreviatedNumericTypeConverter
 
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
 
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
 
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.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
 
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
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
 
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
 
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
 
getType() - Method in class com.github.rvesse.airline.model.CommandMetadata
 
getTypeConverter() - Method in class com.github.rvesse.airline.model.ParserMetadata
Gets the type converter to use
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
getTypeConverter(OptionMetadata, ParseState<T>) - Method in class com.github.rvesse.airline.types.DefaultTypeConverterProvider
 
getTypeConverter(ArgumentsMetadata, 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(ArgumentsMetadata, 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(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
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
 
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(Object) - Method in class com.github.rvesse.airline.Accessor
 
getValue() - Method in exception com.github.rvesse.airline.parser.errors.ParseOptionConversionException
 
getValue() - Method in class com.github.rvesse.airline.types.numerics.NumericCandidate
 
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.help.Help
 
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>, ParserMetadata<T>) - Constructor for class com.github.rvesse.airline.model.GlobalMetadata
 
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
Group - Annotation Type in com.github.rvesse.airline.annotations
Marks a class as providing command group metadata
group - Variable in class com.github.rvesse.airline.help.suggester.GroupSuggester
 
Group.NO_DEFAULT - Class in com.github.rvesse.airline.annotations
 
Group.NO_DEFAULT() - Constructor for class com.github.rvesse.airline.annotations.Group.NO_DEFAULT
 
GroupBuilder<C> - Class in com.github.rvesse.airline.builder
 
GroupFinder - Class in com.github.rvesse.airline.utils.predicates.parser
 
GroupFinder(String) - Constructor for class com.github.rvesse.airline.utils.predicates.parser.GroupFinder
 
Groups - Annotation Type in com.github.rvesse.airline.annotations
Marks a class as providing multiple command group metadata
groups - Variable in class com.github.rvesse.airline.builder.CliBuilder
 
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
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
 
hasSuffix() - Method in class com.github.rvesse.airline.types.numerics.NumericCandidate
 
Help<T> - Class in com.github.rvesse.airline.help
 
Help() - Constructor for class com.github.rvesse.airline.help.Help
 
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, 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, 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(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>, 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>, boolean, OutputStream) - Static method in class com.github.rvesse.airline.help.Help
Displays plain text format program help to the given output stream
help - Variable in class com.github.rvesse.airline.HelpOption
 
HelpFormat - Enum in com.github.rvesse.airline.help.sections
Enumeration of help formats, a HelpSection or HelpHint may provide this but help generators are not obliged to follow this
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
 
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
htmlize(String) - Method in class com.github.rvesse.airline.help.common.AbstractUsageGenerator
HTMLizes a string i.e.

I

inAnyAcceptableRange(int) - Method in class com.github.rvesse.airline.restrictions.common.PortRestriction
 
includeHidden() - Method in class com.github.rvesse.airline.help.common.AbstractUsageGenerator
Gets whether hidden commands and options should be included in the output
includeHidden - Variable in class com.github.rvesse.airline.help.Help
 
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
 
inRange(int) - Method in enum com.github.rvesse.airline.annotations.restrictions.PortType
Gets whether a port falls within the range of this port type
inRange(Object) - Method in class com.github.rvesse.airline.restrictions.common.RangeRestriction
 
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
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, Object) - Method in class com.github.rvesse.airline.restrictions.common.PortRestriction
 
invalidPort(String, Object) - Method in class com.github.rvesse.airline.restrictions.common.PortRestriction
 
isExactNameMatch(String, T) - Method in class com.github.rvesse.airline.utils.predicates.AbstractAbbreviationFinder
 
isExactNameMatch(String, CommandMetadata) - Method in class com.github.rvesse.airline.utils.predicates.parser.AbbreviatedCommandFinder
 
isExactNameMatch(String, CommandGroupMetadata) - Method in class com.github.rvesse.airline.utils.predicates.parser.AbbreviatedGroupFinder
 
isExactNameMatch(String, OptionMetadata) - Method in class com.github.rvesse.airline.utils.predicates.parser.AbbreviatedOptionFinder
 
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, T) - Method in class com.github.rvesse.airline.utils.predicates.AbstractAbbreviationFinder
 
isPartialNameMatch(String, CommandMetadata) - Method in class com.github.rvesse.airline.utils.predicates.parser.AbbreviatedCommandFinder
 
isPartialNameMatch(String, CommandGroupMetadata) - Method in class com.github.rvesse.airline.utils.predicates.parser.AbbreviatedGroupFinder
 
isPartialNameMatch(String, OptionMetadata) - Method in class com.github.rvesse.airline.utils.predicates.parser.AbbreviatedOptionFinder
 
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
 
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.LengthRestriction
 
isValid(String) - Method in class com.github.rvesse.airline.restrictions.common.NotBlankRestriction
 
isValid(String) - Method in class com.github.rvesse.airline.restrictions.common.NotEmptyRestriction
 

K

KiloAs1000 - Class in com.github.rvesse.airline.types.numerics.abbreviated
 
KiloAs1000() - Constructor for class com.github.rvesse.airline.types.numerics.abbreviated.KiloAs1000
 
KiloAs1024 - Class in com.github.rvesse.airline.types.numerics.abbreviated
 
KiloAs1024() - Constructor for class com.github.rvesse.airline.types.numerics.abbreviated.KiloAs1024
 

L

last(Iterable<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(Iterable<T>, 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
 
LengthRestriction - Class in com.github.rvesse.airline.restrictions.common
A restriction that requires string values
LengthRestriction(int, boolean) - Constructor for class com.github.rvesse.airline.restrictions.common.LengthRestriction
 
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
listCopy(Collection<T>) - Static method in class com.github.rvesse.airline.utils.AirlineUtils
 
listCopy(Iterable<T>) - Static method in class com.github.rvesse.airline.utils.AirlineUtils
 
ListValueOptionParser<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.
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
 
loadCommand(Class<?>) - 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>>) - Static method in class com.github.rvesse.airline.model.MetadataLoader
Loads command meta-data
loadCommandsIntoGroupsByAnnotation(List<CommandMetadata>, List<CommandGroupMetadata>, List<CommandMetadata>) - Static method in class com.github.rvesse.airline.model.MetadataLoader
 
loadGlobal(Class<?>) - Static method in class com.github.rvesse.airline.model.MetadataLoader
 
loadGlobal(String, String, CommandMetadata, Iterable<CommandMetadata>, Iterable<CommandGroupMetadata>, Iterable<GlobalRestriction>, ParserMetadata<C>) - Static method in class com.github.rvesse.airline.model.MetadataLoader
Loads global meta-data
loadInjectionMetadata(Class<?>) - Static method in class com.github.rvesse.airline.model.MetadataLoader
Loads injection meta-data
loadInjectionMetadata(Class<?>, MetadataLoader.InjectionMetadata, List<Field>) - Static method in class com.github.rvesse.airline.model.MetadataLoader
Loads injection meta-data
loadParser(Class<?>) - Static method in class com.github.rvesse.airline.model.MetadataLoader
 
loadSuggester(Class<? extends Suggester>) - Static method in class com.github.rvesse.airline.model.MetadataLoader
Loads suggester meta-data
LocaleSensitiveStringFinder - Class in com.github.rvesse.airline.utils.predicates
 
LocaleSensitiveStringFinder(String, Locale) - Constructor for class com.github.rvesse.airline.utils.predicates.LocaleSensitiveStringFinder
 
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

M

makeHidden() - Method in class com.github.rvesse.airline.builder.GroupBuilder
 
makeVisible() - Method in class com.github.rvesse.airline.builder.GroupBuilder
 
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
 
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)
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
 
metadata - Variable in class com.github.rvesse.airline.help.suggester.GlobalSuggester
 
metadata - Variable in class com.github.rvesse.airline.help.suggester.SuggestCommand
 
MetadataLoader - Class in com.github.rvesse.airline.model
Helper for loading meta-data
MetadataLoader() - Constructor for class com.github.rvesse.airline.model.MetadataLoader
 
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)
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
 
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
 
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.builder.CliBuilder
 
newInstance() - Static method in class com.github.rvesse.airline.parser.ParseState
 
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
 
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
 
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
 
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.LengthRestriction
 
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.RangeRestriction
 
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.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
 
numericTypeConverter - Variable in class com.github.rvesse.airline.builder.ParserBuilder
 
NumericTypeConverter - Interface in com.github.rvesse.airline.types.numerics
Interfaces for numeric type converters

O

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
 
Once - Annotation Type in com.github.rvesse.airline.annotations.restrictions
An annotation that marks that an option may occur at most once
Option - Annotation Type in com.github.rvesse.airline.annotations
Annotation to mark a field as an option
OptionFinder - Class in com.github.rvesse.airline.utils.predicates.parser
 
OptionFinder(String) - Constructor for class com.github.rvesse.airline.utils.predicates.parser.OptionFinder
 
OptionMetadata - Class in com.github.rvesse.airline.model
 
OptionMetadata(OptionType, Iterable<String>, 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
 
OptionParser<T> - Interface in com.github.rvesse.airline.parser.options
Interface for option parsers
optionParsers - Variable in class com.github.rvesse.airline.builder.ParserBuilder
 
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
optionSeparators - Variable in class com.github.rvesse.airline.builder.CliBuilder
 
OptionType - Enum in com.github.rvesse.airline.annotations
 
ORDER_COPYRIGHT - Static variable in class com.github.rvesse.airline.help.sections.common.CommonSections
 
ORDER_DISCUSSION - Static variable in class com.github.rvesse.airline.help.sections.common.CommonSections
 
ORDER_EXAMPLES - Static variable in class com.github.rvesse.airline.help.sections.common.CommonSections
 
ORDER_EXIT_CODES - Static variable in class com.github.rvesse.airline.help.sections.common.CommonSections
 
ORDER_LICENSE - Static variable in class com.github.rvesse.airline.help.sections.common.CommonSections
 
ORDER_VERSION - Static variable in class com.github.rvesse.airline.help.sections.common.CommonSections
 
outputArguments(UsagePrinter, ArgumentsMetadata, ParserMetadata<T>) - Method in class com.github.rvesse.airline.help.cli.CliUsageHelper
 
outputArgumentsRestriction(UsagePrinter, ArgumentsMetadata, ArgumentsRestriction, HelpHint) - Method in class com.github.rvesse.airline.help.cli.CliUsageHelper
Outputs documentation about a restriction on an option
outputCommandDescription(UsagePrinter, CommandGroupMetadata, CommandMetadata) - Method in class com.github.rvesse.airline.help.cli.CliGlobalUsageGenerator
Outputs the description for a command
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
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, GlobalMetadata<T>) - Method in class com.github.rvesse.airline.help.cli.CliGlobalUsageGenerator
Outputs a documentation section with a description of the CLI
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(UsagePrinter, GlobalMetadata<T>, List<CommandGroupMetadata>) - Method in class com.github.rvesse.airline.help.cli.CliGlobalUsageGenerator
 
outputHelpSection(UsagePrinter, HelpSection) - Method in class com.github.rvesse.airline.help.cli.CliUsageHelper
Outputs a help section
outputHint(UsagePrinter, HelpHint, boolean) - Method in class com.github.rvesse.airline.help.cli.CliUsageHelper
 
outputOptionRestriction(UsagePrinter, OptionMetadata, OptionRestriction, HelpHint) - Method in class com.github.rvesse.airline.help.cli.CliUsageHelper
Outputs documentation about a restriction on an option
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
 
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
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, 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
outputUserAliases(UsagePrinter, GlobalMetadata<T>, UserAliasesSource<T>) - Method in class com.github.rvesse.airline.help.cli.CliGlobalUsageGenerator
 
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.

P

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) - Static method in class com.github.rvesse.airline.parser.aliases.AliasArgumentsParser
 
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(ParserMetadata<T>, CommandMetadata, Iterable<GlobalRestriction>, Iterable<String>) - Method in class com.github.rvesse.airline.parser.command.SingleCommandParser
 
parse(GlobalMetadata<T>, Iterable<String>) - Method in class com.github.rvesse.airline.parser.suggester.SuggestionParser
 
parse(String...) - Method in class com.github.rvesse.airline.SingleCommand
Parses the arguments to produce a command instance
parse(Iterable<String>) - Method in class com.github.rvesse.airline.SingleCommand
Parses the arguments to produce a command instance
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
 
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
 
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(List<String>) - Constructor for exception com.github.rvesse.airline.parser.errors.ParseArgumentsMissingException
 
ParseArgumentsMissingException(String, List<String>, Object...) - 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
 
ParsedOptionFinder - Class in com.github.rvesse.airline.utils.predicates.parser
 
ParsedOptionFinder(OptionMetadata) - Constructor for class com.github.rvesse.airline.utils.predicates.parser.ParsedOptionFinder
 
ParseException - Exception in com.github.rvesse.airline.parser.errors
Super class of all command line parsing exceptions
ParseException(String, Object...) - Constructor for exception com.github.rvesse.airline.parser.errors.ParseException
 
ParseException(Exception, 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(String, Object...) - Constructor for exception com.github.rvesse.airline.parser.errors.ParseInvalidRestrictionException
 
ParseInvalidRestrictionException(Exception, 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, 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
 
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.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.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
 
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
 
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(String, Object...) - Constructor for exception com.github.rvesse.airline.parser.errors.ParseRestrictionViolatedException
 
ParseRestrictionViolatedException(Exception, 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>, List<OptionParser<T>>, TypeConverter, ParserErrorHandler, boolean, boolean, List<AliasMetadata>, UserAliasesSource<T>, boolean, boolean, String, String) - Constructor for class com.github.rvesse.airline.model.ParserMetadata
 
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
 
ParseTooManyArgumentsException - Exception in com.github.rvesse.airline.parser.errors
Error that is thrown if too many arguments are provided
ParseTooManyArgumentsException(String, Object...) - Constructor for exception com.github.rvesse.airline.parser.errors.ParseTooManyArgumentsException
 
ParseTooManyArgumentsException(Exception, String, Object...) - Constructor for exception com.github.rvesse.airline.parser.errors.ParseTooManyArgumentsException
 
parseWithResult(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.Cli
Parses the arguments to produce a result.
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(String...) - Method in class com.github.rvesse.airline.SingleCommand
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.
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 an Option or Arguments annotated field but rather applies only to certain values
PartialRestriction - Class in com.github.rvesse.airline.restrictions.common
 
PartialRestriction(int[], OptionRestriction) - Constructor for class com.github.rvesse.airline.restrictions.common.PartialRestriction
 
PartialRestriction(int[], 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
 
PartialRestriction(Collection<Integer>, ArgumentsRestriction) - Constructor for class com.github.rvesse.airline.restrictions.common.PartialRestriction
 
Partials - Annotation Type in com.github.rvesse.airline.annotations.restrictions
Annotation which is used to provide multiple Partial annotations to a Option or Arguments annotated field
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
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
 
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
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
PortRestriction - Class in com.github.rvesse.airline.restrictions.common
 
PortRestriction(PortType...) - 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
postValidate(ParseState<T>, OptionMetadata, Object) - Method in class com.github.rvesse.airline.restrictions.AbstractCommonRestriction
 
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>, OptionMetadata, 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.AllowedValuesRestriction
 
postValidate(ParseState<T>, OptionMetadata, 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.PartialRestriction
 
postValidate(ParseState<T>, OptionMetadata, 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.PortRestriction
 
postValidate(ParseState<T>, OptionMetadata, Object) - Method in class com.github.rvesse.airline.restrictions.common.RangeRestriction
 
postValidate(ParseState<T>, ArgumentsMetadata, 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
 
preValidate(ParseState<T>, OptionMetadata, String) - Method in class com.github.rvesse.airline.restrictions.AbstractCommonRestriction
 
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>, OptionMetadata, 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.AbstractStringRestriction
 
preValidate(ParseState<T>, OptionMetadata, 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.AllowedRawValuesRestriction
 
preValidate(ParseState<T>, OptionMetadata, 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.PartialRestriction
 
preValidate(ParseState<T>, OptionMetadata, 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.PathRestriction
 
preValidate(ParseState<T>, OptionMetadata, String) - Method in class com.github.rvesse.airline.restrictions.common.PatternRestriction
 
preValidate(ParseState<T>, ArgumentsMetadata, 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
 
ProseSection - Annotation Type in com.github.rvesse.airline.annotations.help
Annotation that provides a prose section for a commands help
ProseSection - Class in com.github.rvesse.airline.help.sections.common
 
ProseSection(String, String[]) - Constructor for class com.github.rvesse.airline.help.sections.common.ProseSection
 
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
 
pushContext(Context) - Method in class com.github.rvesse.airline.parser.ParseState
 

R

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
 
rawValues - Variable in class com.github.rvesse.airline.restrictions.common.AbstractAllowedValuesRestriction
 
Required - Annotation Type in com.github.rvesse.airline.annotations.restrictions
An annotation that indicates that an option/arguments is required
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
 
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
 
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.
reset() - Static method in class com.github.rvesse.airline.help.sections.factories.HelpSectionRegistry
 
reset() - Static method in class com.github.rvesse.airline.restrictions.factories.RestrictionRegistry
Resets the registry to its default state
resetCollection() - Method in class com.github.rvesse.airline.parser.errors.handlers.AbstractCollectingHandler
 
resolveAliases(PeekingIterator<String>, ParseState<T>) - Method in class com.github.rvesse.airline.parser.aliases.AliasResolver
 
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
 
run() - Method in class com.github.rvesse.airline.help.Help
 
run() - Method in class com.github.rvesse.airline.help.suggester.SuggestCommand
 

S

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
 
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
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
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
SimpleRestrictionsFactory - Class in com.github.rvesse.airline.restrictions.factories
 
SimpleRestrictionsFactory() - Constructor for class com.github.rvesse.airline.restrictions.factories.SimpleRestrictionsFactory
 
SingleCommand<C> - Class in com.github.rvesse.airline
Class for encapsulating and parsing single commands
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
SingleCommandParser<T> - Class in com.github.rvesse.airline.parser.command
 
SingleCommandParser() - Constructor for class com.github.rvesse.airline.parser.command.SingleCommandParser
 
singletonList(T) - Static method in class com.github.rvesse.airline.utils.AirlineUtils
 
singletonMap(K, V) - Static method in class com.github.rvesse.airline.utils.AirlineUtils
 
singletonSet(T) - Static method in class com.github.rvesse.airline.utils.AirlineUtils
 
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
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
 
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
 
subGroups - Variable in class com.github.rvesse.airline.builder.GroupBuilder
 
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 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
 
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
 
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.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.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.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
 

T

TITLE_COPYRIGHT - Static variable in class com.github.rvesse.airline.help.sections.common.CommonSections
 
TITLE_DISCUSSION - Static variable in class com.github.rvesse.airline.help.sections.common.CommonSections
 
TITLE_EXAMPLES - Static variable in class com.github.rvesse.airline.help.sections.common.CommonSections
 
TITLE_EXIT_CODES - Static variable in class com.github.rvesse.airline.help.sections.common.CommonSections
 
TITLE_LICENSE - Static variable in class com.github.rvesse.airline.help.sections.common.CommonSections
 
TITLE_VERSION - Static variable in class com.github.rvesse.airline.help.sections.common.CommonSections
 
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
 
toGroupNames(List<CommandGroupMetadata>) - Static method in class com.github.rvesse.airline.help.UsageHelper
 
toOrdinal(int) - Static method in class com.github.rvesse.airline.utils.AirlineUtils
 
toRangesString(Iterable<PortType>) - 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.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.types.numerics.NumericCandidate
 
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
 
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
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
tryParse(GlobalMetadata<T>, String...) - Method in class com.github.rvesse.airline.parser.AbstractCommandParser
Tries to parse the arguments
tryParse(GlobalMetadata<T>, Iterable<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
typeConverter - Variable in class com.github.rvesse.airline.builder.ParserBuilder
 
TypeConverter - Interface in com.github.rvesse.airline.types
Interface for type converters
TypeConverterProvider - Interface in com.github.rvesse.airline.types
Interface for type converter providers

U

unmodifiableListCopy(Collection<T>) - Static method in class com.github.rvesse.airline.utils.AirlineUtils
 
unmodifiableListCopy(Iterable<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
 
Unrestricted - Annotation Type in com.github.rvesse.airline.annotations.restrictions
An annotation that indicates that no restrictions should apply
usage(GlobalMetadata<T>, CommandGroupMetadata[], UsagePrinter) - Method in class com.github.rvesse.airline.help.cli.CliCommandGroupUsageGenerator
 
usage(String, String[], String, CommandMetadata, ParserMetadata<T>, UsagePrinter) - Method in class com.github.rvesse.airline.help.cli.CliCommandUsageGenerator
 
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>, CommandGroupMetadata[]) - Method in interface com.github.rvesse.airline.help.CommandGroupUsageGenerator
Generate the help and output it on standard out
usage(GlobalMetadata<T>, CommandGroupMetadata[], OutputStream) - Method in interface com.github.rvesse.airline.help.CommandGroupUsageGenerator
Generate the help and output it to the stream
usage(String, String[], String, CommandMetadata) - Method in interface com.github.rvesse.airline.help.CommandUsageGenerator
Deprecated.
Please use the overload that takes the parser configuration explicitly
usage(String, String[], String, CommandMetadata, OutputStream) - Method in interface com.github.rvesse.airline.help.CommandUsageGenerator
Deprecated.
Please use the overload that takes the parser configuration explicitly
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>, OutputStream) - Method in interface com.github.rvesse.airline.help.CommandUsageGenerator
Generate the help and output it to the stream
usage(GlobalMetadata<T>, CommandGroupMetadata[]) - Method in class com.github.rvesse.airline.help.common.AbstractCommandGroupUsageGenerator
 
usage(String, String[], String, CommandMetadata, ParserMetadata<T>) - Method in class com.github.rvesse.airline.help.common.AbstractCommandUsageGenerator
 
usage(String, String[], String, CommandMetadata) - Method in class com.github.rvesse.airline.help.common.AbstractCommandUsageGenerator
Deprecated.
Please use the overload that explicitly takes a parser configuration
usage(String, String[], String, CommandMetadata, OutputStream) - Method in class com.github.rvesse.airline.help.common.AbstractCommandUsageGenerator
Deprecated.
Please use the overload that explicitly takes a parser configuration
usage(GlobalMetadata<T>) - Method in class com.github.rvesse.airline.help.common.AbstractGlobalUsageGenerator
 
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 class com.github.rvesse.airline.help.common.AbstractPrintedCommandGroupUsageGenerator
 
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>, OutputStream) - Method in class com.github.rvesse.airline.help.common.AbstractPrintedCommandUsageGenerator
 
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>, OutputStream) - Method in class com.github.rvesse.airline.help.common.AbstractPrintedGlobalUsageGenerator
 
usage(GlobalMetadata<T>) - Method in interface com.github.rvesse.airline.help.GlobalUsageGenerator
Generate the help and output it on standard out
usage(GlobalMetadata<T>, OutputStream) - Method in interface com.github.rvesse.airline.help.GlobalUsageGenerator
Generate the help and output it to the stream
UsageHelper - Class in com.github.rvesse.airline.help
 
UsageHelper() - Constructor for class com.github.rvesse.airline.help.UsageHelper
 
userAliases - Variable in class com.github.rvesse.airline.builder.ParserBuilder
 
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
 

V

validate(ParseState<T>) - Method in class com.github.rvesse.airline.parser.command.CliParser
Validates the parser state
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
 
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
 
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.help.sections.HelpFormat
Returns the enum constant of this type with the specified name.
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.help.sections.HelpFormat
Returns an array containing the constants of this enum type, in the order they are declared.
Version - Annotation Type in com.github.rvesse.airline.annotations.help
 
VersionSection - Class in com.github.rvesse.airline.help.sections.common
 
VersionSection(String[], String, String, String, String, String[], String[], boolean, boolean) - Constructor for class com.github.rvesse.airline.help.sections.common.VersionSection
 
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) returns false
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) returns false
violated(ParseState<T>, OptionMetadata, 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.LengthRestriction
 
violated(ParseState<T>, OptionMetadata, 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.NotBlankRestriction
 
violated(ParseState<T>, OptionMetadata, 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.NotEmptyRestriction
 

W

wasSuccessful() - Method in class com.github.rvesse.airline.parser.ParseResult
Indicates whether parsing was successful
wasSuccessfull() - Method in class com.github.rvesse.airline.types.ConvertResult
Whether the conversion was successful
withAlias(String) - Method in class com.github.rvesse.airline.builder.ParserBuilder
 
withAliasesChaining() - Method in class com.github.rvesse.airline.builder.ParserBuilder
 
withAliasesOverridingBuiltIns() - Method in class com.github.rvesse.airline.builder.ParserBuilder
 
withArgument(String) - Method in class com.github.rvesse.airline.builder.AliasBuilder
 
withArgument(ArgumentsMetadata, String) - Method in class com.github.rvesse.airline.parser.ParseState
 
withArguments(String...) - Method in class com.github.rvesse.airline.builder.AliasBuilder
 
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.
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
 
withCommand(CommandMetadata) - Method in class com.github.rvesse.airline.parser.ParseState
 
withCommandAbbreviation() - Method in class com.github.rvesse.airline.builder.ParserBuilder
 
withCommandFactory(CommandFactory<C>) - Method in class com.github.rvesse.airline.builder.ParserBuilder
 
withCommands(Class<? extends C>, 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.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.GroupBuilder
 
withConfiguration(ParserMetadata<T>) - Method in class com.github.rvesse.airline.parser.ParseState
 
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
 
withDefaultErrorHandler() - Method in class com.github.rvesse.airline.builder.ParserBuilder
 
withDefaultNumericTypeConverter() - Method in class com.github.rvesse.airline.builder.ParserBuilder
Indicates that default numeric type conversion should 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
withDefaultRestrictions() - Method in class com.github.rvesse.airline.builder.CliBuilder
 
withDefaultTypeConverter() - Method in class com.github.rvesse.airline.builder.ParserBuilder
 
withDescription(String) - Method in class com.github.rvesse.airline.builder.CliBuilder
 
withDescription(String) - Method in class com.github.rvesse.airline.builder.GroupBuilder
 
withErrorHandler(ParserErrorHandler) - Method in class com.github.rvesse.airline.builder.ParserBuilder
 
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 to true.
withGlobal(GlobalMetadata<T>) - Method in class com.github.rvesse.airline.parser.ParseState
 
withGroup(String) - Method in class com.github.rvesse.airline.builder.CliBuilder
 
withGroup(CommandGroupMetadata) - Method in class com.github.rvesse.airline.parser.ParseState
 
withHiddenState(boolean) - Method in class com.github.rvesse.airline.builder.GroupBuilder
 
withNoRestrictions() - Method in class com.github.rvesse.airline.builder.CliBuilder
 
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
 
withOptionAbbreviation() - Method in class com.github.rvesse.airline.builder.ParserBuilder
 
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
withOptionValue(OptionMetadata, String) - Method in class com.github.rvesse.airline.parser.ParseState
 
withParser() - Method in class com.github.rvesse.airline.builder.CliBuilder
 
withRestriction(GlobalRestriction) - Method in class com.github.rvesse.airline.builder.CliBuilder
 
withRestrictions(GlobalRestriction...) - Method in class com.github.rvesse.airline.builder.CliBuilder
 
withSubGroup(String) - Method in class com.github.rvesse.airline.builder.GroupBuilder
 
withTypeConverter(TypeConverter) - Method in class com.github.rvesse.airline.builder.ParserBuilder
 
withUnparsedInput(String) - Method in class com.github.rvesse.airline.parser.ParseState
 
withUserAliases(String) - Method in class com.github.rvesse.airline.builder.ParserBuilder
Reads in user aliases from the default configuration file in the default location.
withUserAliases(String, String) - Method in class com.github.rvesse.airline.builder.ParserBuilder
Reads in user aliases from the default configuration file in the default location
withUserAliases(String, String, String...) - Method in class com.github.rvesse.airline.builder.ParserBuilder
Reads in user aliases from the default configuration file in the default location
A B C D E F G H I K L M N O P R S T U V W 

Copyright © 2012–2017. All rights reserved.