com.github.rvesse.airline.model

Class GlobalMetadata<T>

java.lang.Object

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

public class GlobalMetadata<T>
extends Object

Represents metadata about a CLI

Constructor Summary

Constructors

Constructor and Description
GlobalMetadata(String name, String description, Iterable<OptionMetadata> options, CommandMetadata defaultCommand, Iterable<CommandMetadata> defaultGroupCommands, Iterable<CommandGroupMetadata> commandGroups, Iterable<GlobalRestriction> restrictions, Iterable<HelpSection> baseHelpSections, ParserMetadata<T> parserConfig)

Method Summary

Modifier and Type	Method and Description
List<HelpSection>	getBaseHelpSections() Gets the base help sections used by all commands unless specifically overridden by individual commands
List<CommandGroupMetadata>	getCommandGroups() Gets the command groups for the CLI
CommandMetadata	getDefaultCommand() Gets the default command for the CLI
List<CommandMetadata>	getDefaultGroupCommands() Gets the default group of commands for the CLI i.e.
String	getDescription() Gets the description of the CLI
String	getName() Gets the name of the CLI
List<OptionMetadata>	getOptions() Gets the global scoped options
ParserMetadata<T>	getParserConfiguration() Gets the parser configuration for the CLI
List<GlobalRestriction>	getRestrictions() Gets the global restrictions
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GlobalMetadata

public GlobalMetadata(String name,
                      String description,
                      Iterable<OptionMetadata> options,
                      CommandMetadata defaultCommand,
                      Iterable<CommandMetadata> defaultGroupCommands,
                      Iterable<CommandGroupMetadata> commandGroups,
                      Iterable<GlobalRestriction> restrictions,
                      Iterable<HelpSection> baseHelpSections,
                      ParserMetadata<T> parserConfig)

Method Detail

getName

public String getName()

Gets the name of the CLI

Returns:

Name

getDescription

public String getDescription()

Gets the description of the CLI

Returns:

Description

getOptions

public List<OptionMetadata> getOptions()

Gets the global scoped options

Returns:

Options

getDefaultCommand

public CommandMetadata getDefaultCommand()

Gets the default command for the CLI

Returns:

Default command

getDefaultGroupCommands

public List<CommandMetadata> getDefaultGroupCommands()

Gets the default group of commands for the CLI i.e. commands that don't need a group to be specified

Returns:

Default group commands

getCommandGroups

public List<CommandGroupMetadata> getCommandGroups()

Gets the command groups for the CLI

Returns:

Command groups

getRestrictions

public List<GlobalRestriction> getRestrictions()

Gets the global restrictions

Returns:

Global restrictions

getBaseHelpSections

public List<HelpSection> getBaseHelpSections()

Gets the base help sections used by all commands unless specifically overridden by individual commands

Returns:

Base help sections

getParserConfiguration

public ParserMetadata<T> getParserConfiguration()

Gets the parser configuration for the CLI

Returns:

Parser configuration

toString

public String toString()

Overrides:

toString in class Object