com.github.rvesse.airline.model

Class ParserMetadata<T>

java.lang.Object

com.github.rvesse.airline.model.ParserMetadata<T>

public class ParserMetadata<T>
extends Object

Represents meta-data about the parser configuration

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ARGUMENTS_SEPARATOR Default separator used to separate arguments from options

Constructor Summary

Constructors

Constructor and Description

ParserMetadata(CommandFactory<T> commandFactory, List<OptionParser<T>> optionParsers, TypeConverter typeConverter, ParserErrorHandler errorHandler, boolean allowAbbreviateCommands, boolean allowAbbreviatedOptions, List<AliasMetadata> aliases, UserAliasesSource<T> userAliases, boolean aliasesOverrideBuiltIns, boolean aliasesMayChain, char forceBuiltInPrefix, String argumentsSeparator, String flagNegationPrefix)

Method Summary

Modifier and Type	Method and Description
boolean	aliasesMayChain() Gets whether aliases may chain i.e.
boolean	aliasesOverrideBuiltIns() Gets whether aliases can override built-in commands
boolean	allowsAbbreviatedCommands() Gets whether command/group name abbreviation is allowed
boolean	allowsAbbreviatedOptions() Gets whether option name abbreviation is allowed
boolean	allowsFlagNegation() Gets whether this configuration allows flag negation
List<AliasMetadata>	getAliases() Gets the defined command aliases
char	getAliasForceBuiltInPrefix() Gets the prefix character used in alias definitions to indicate that when resolving an alias that it should force the built-in to be called even if there is an alias of that name and built-in overriding is enabled
String	getArgumentsSeparator() Gets the arguments separator to be used
CommandFactory<T>	getCommandFactory() Gets the command factory to use
ParserErrorHandler	getErrorHandler() Gets the error handler to use
String	getFlagNegationPrefix() Gets the flag negation prefix that is in use (if any)
List<OptionParser<T>>	getOptionParsers() Gets the option parsers to use
TypeConverter	getTypeConverter() Gets the type converter to use
UserAliasesSource<T>	getUserAliasesSource() Gets the user aliases source (if any)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_ARGUMENTS_SEPARATOR

public static final String DEFAULT_ARGUMENTS_SEPARATOR

Default separator used to separate arguments from options

See Also:

Constant Field Values

Constructor Detail

ParserMetadata

public ParserMetadata(CommandFactory<T> commandFactory,
                      List<OptionParser<T>> optionParsers,
                      TypeConverter typeConverter,
                      ParserErrorHandler errorHandler,
                      boolean allowAbbreviateCommands,
                      boolean allowAbbreviatedOptions,
                      List<AliasMetadata> aliases,
                      UserAliasesSource<T> userAliases,
                      boolean aliasesOverrideBuiltIns,
                      boolean aliasesMayChain,
                      char forceBuiltInPrefix,
                      String argumentsSeparator,
                      String flagNegationPrefix)

Method Detail

getCommandFactory

public CommandFactory<T> getCommandFactory()

Gets the command factory to use

Returns:

Command factory

getTypeConverter

public TypeConverter getTypeConverter()

Gets the type converter to use

Returns:

Type converter

getErrorHandler

public ParserErrorHandler getErrorHandler()

Gets the error handler to use

Returns:

Error handler

getAliases

public List<AliasMetadata> getAliases()

Gets the defined command aliases

Returns:

Aliases

getUserAliasesSource

public UserAliasesSource<T> getUserAliasesSource()

Gets the user aliases source (if any)

Returns:

User aliases source

aliasesOverrideBuiltIns

public boolean aliasesOverrideBuiltIns()

Gets whether aliases can override built-in commands

Returns:

True if they can override, false otherwise

aliasesMayChain

public boolean aliasesMayChain()

Gets whether aliases may chain i.e. whether one alias may reference another

Returns:

True if they can chain, false otherwise

getAliasForceBuiltInPrefix

public char getAliasForceBuiltInPrefix()

Gets the prefix character used in alias definitions to indicate that when resolving an alias that it should force the built-in to be called even if there is an alias of that name and built-in overriding is enabled

Returns:

Force built in prefix character

getOptionParsers

public List<OptionParser<T>> getOptionParsers()

Gets the option parsers to use

Returns:

Option parsers

allowsAbbreviatedCommands

public boolean allowsAbbreviatedCommands()

Gets whether command/group name abbreviation is allowed

Returns:

True if allowed, false otherwise

allowsAbbreviatedOptions

public boolean allowsAbbreviatedOptions()

Gets whether option name abbreviation is allowed

Returns:

True if allowed, false otherwise

getArgumentsSeparator

public String getArgumentsSeparator()

Gets the arguments separator to be used

Returns:

Arguments separator

allowsFlagNegation

public boolean allowsFlagNegation()

Gets whether this configuration allows flag negation

Returns:

True if negation is allowed, false otherwise

getFlagNegationPrefix

public String getFlagNegationPrefix()

Gets the flag negation prefix that is in use (if any)

Returns:

Flag negation prefix, may be null if not enabled

toString

public String toString()

Overrides:

toString in class Object