Class GlobalMetadata<T>

java.lang.Object

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

public class GlobalMetadata<T>
extends Object

Represents metadata about a CLI

Field Summary

Fields

Modifier and Type	Field	Description
private final List<HelpSection>	baseHelpSections
private final List<CommandGroupMetadata>	commandGroups
private final CommandMetadata	defaultCommand
private final List<CommandMetadata>	defaultGroupCommands
private final String	description
private final String	name
private final List<OptionMetadata>	options
private final ParserMetadata<T>	parserConfig
private final List<GlobalRestriction>	restrictions

Constructor Summary

Constructors

Constructor	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	Description
private static void	checkForSuppressedCommands(CommandGroupMetadata group, String groupPath)
private static void	checkForSuppressedCommands(List<CommandMetadata> commands, CommandMetadata defaultCommand, String groupName)
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
private static void	suppressedCommand(Class<?> cls, CommandMetadata cmd, String groupName)
String	toString()

Methods inherited from class Object

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

Field Details

name

private final String name

description

private final String description

options

private final List<OptionMetadata> options

defaultCommand

private final CommandMetadata defaultCommand

defaultGroupCommands

private final List<CommandMetadata> defaultGroupCommands

commandGroups

private final List<CommandGroupMetadata> commandGroups

parserConfig

private final ParserMetadata<T> parserConfig

restrictions

private final List<GlobalRestriction> restrictions

baseHelpSections

private final List<HelpSection> baseHelpSections

Constructor Details

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 Details

checkForSuppressedCommands

private static void checkForSuppressedCommands(CommandGroupMetadata group,
 String groupPath)

checkForSuppressedCommands

private static void checkForSuppressedCommands(List<CommandMetadata> commands,
 CommandMetadata defaultCommand,
 String groupName)

suppressedCommand

private static void suppressedCommand(Class<?> cls,
 CommandMetadata cmd,
 String groupName)

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