Module com.github.rvesse.airline

Package com.github.rvesse.airline.model

Class GlobalMetadata<T>

java.lang.Object

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

public class GlobalMetadata<T>
extends java.lang.Object

Represents metadata about a CLI

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
private static void	checkForSuppressedCommands(CommandGroupMetadata group, java.lang.String groupPath)
private static void	checkForSuppressedCommands(java.util.List<CommandMetadata> commands, CommandMetadata defaultCommand, java.lang.String groupName)
java.util.List<HelpSection>	getBaseHelpSections()	Gets the base help sections used by all commands unless specifically overridden by individual commands
java.util.List<CommandGroupMetadata>	getCommandGroups()	Gets the command groups for the CLI
CommandMetadata	getDefaultCommand()	Gets the default command for the CLI
java.util.List<CommandMetadata>	getDefaultGroupCommands()	Gets the default group of commands for the CLI i.e.
java.lang.String	getDescription()	Gets the description of the CLI
java.lang.String	getName()	Gets the name of the CLI
java.util.List<OptionMetadata>	getOptions()	Gets the global scoped options
ParserMetadata<T>	getParserConfiguration()	Gets the parser configuration for the CLI
java.util.List<GlobalRestriction>	getRestrictions()	Gets the global restrictions
private static void	suppressedCommand(java.lang.Class<?> cls, CommandMetadata cmd, java.lang.String groupName)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

name

private final java.lang.String name

description

private final java.lang.String description

options

private final java.util.List<OptionMetadata> options

defaultCommand

private final CommandMetadata defaultCommand

defaultGroupCommands

private final java.util.List<CommandMetadata> defaultGroupCommands

commandGroups

private final java.util.List<CommandGroupMetadata> commandGroups

parserConfig

private final ParserMetadata<T> parserConfig

restrictions

private final java.util.List<GlobalRestriction> restrictions

baseHelpSections

private final java.util.List<HelpSection> baseHelpSections

Constructor Detail

GlobalMetadata

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

Method Detail

checkForSuppressedCommands

private static void checkForSuppressedCommands(CommandGroupMetadata group,
                                               java.lang.String groupPath)

checkForSuppressedCommands

private static void checkForSuppressedCommands(java.util.List<CommandMetadata> commands,
                                               CommandMetadata defaultCommand,
                                               java.lang.String groupName)

suppressedCommand

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

getName

public java.lang.String getName()

Gets the name of the CLI

Returns:

Name

getDescription

public java.lang.String getDescription()

Gets the description of the CLI

Returns:

Description

getOptions

public java.util.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 java.util.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 java.util.List<CommandGroupMetadata> getCommandGroups()

Gets the command groups for the CLI

Returns:

Command groups

getRestrictions

public java.util.List<GlobalRestriction> getRestrictions()

Gets the global restrictions

Returns:

Global restrictions

getBaseHelpSections

public java.util.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 java.lang.String toString()

Overrides:

toString in class java.lang.Object