Class CommandGroupMetadata

java.lang.Object

com.github.rvesse.airline.model.CommandGroupMetadata

public class CommandGroupMetadata
extends Object

Represents meta-data about a command group

Field Summary

Fields

Modifier and Type	Field	Description
private final List<CommandMetadata>	commands
private final CommandMetadata	defaultCommand
private final String	description
private final boolean	hidden
private final String	name
private final List<OptionMetadata>	options
private CommandGroupMetadata	parentGroup
private final List<CommandGroupMetadata>	subGroups

Constructor Summary

Constructors

Constructor	Description
CommandGroupMetadata(String name, String description, boolean hidden, Iterable<OptionMetadata> options, Iterable<CommandGroupMetadata> subGroups, CommandMetadata defaultCommand, Iterable<CommandMetadata> commands)

Method Summary

Modifier and Type	Method	Description
void	addCommand(CommandMetadata command)	Adds a command to the group
void	addSubGroup(CommandGroupMetadata subGroup)	Adds a sub-group to the group
List<CommandMetadata>	getCommands()	Gets the commands for the group
CommandMetadata	getDefaultCommand()	Gets the default command for the group
String	getDescription()	Gets the description for the group
String	getName()	Gets the name of the group
List<OptionMetadata>	getOptions()	Gets the group options
CommandGroupMetadata	getParent()	Gets the parent group which may be null
List<CommandGroupMetadata>	getSubGroups()	Gets the sub-groups of this group
boolean	isHidden()	Gets whether the group is hidden
void	setParent(CommandGroupMetadata parent)	Sets the parent for a group
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

hidden

private final boolean hidden

options

private final List<OptionMetadata> options

defaultCommand

private final CommandMetadata defaultCommand

commands

private final List<CommandMetadata> commands

subGroups

private final List<CommandGroupMetadata> subGroups

parentGroup

private CommandGroupMetadata parentGroup

Constructor Details

CommandGroupMetadata

public CommandGroupMetadata(String name,
 String description,
 boolean hidden,
 Iterable<OptionMetadata> options,
 Iterable<CommandGroupMetadata> subGroups,
 CommandMetadata defaultCommand,
 Iterable<CommandMetadata> commands)

Method Details

getName

public String getName()

Gets the name of the group

Returns:

Name

getDescription

public String getDescription()

Gets the description for the group

Returns:

Description

isHidden

public boolean isHidden()

Gets whether the group is hidden

Returns:

True if hidden, false otherwise

getOptions

public List<OptionMetadata> getOptions()

Gets the group options

Returns:

Group options

getDefaultCommand

public CommandMetadata getDefaultCommand()

Gets the default command for the group

Returns:

Default command

getCommands

public List<CommandMetadata> getCommands()

Gets the commands for the group

Returns:

Commands

addCommand

public void addCommand(CommandMetadata command)

Adds a command to the group

Parameters:

command - Command

getSubGroups

public List<CommandGroupMetadata> getSubGroups()

Gets the sub-groups of this group

Returns:

Sub-groups

addSubGroup

public void addSubGroup(CommandGroupMetadata subGroup)

Adds a sub-group to the group

Parameters:

subGroup - Sub-group

setParent

public void setParent(CommandGroupMetadata parent)

Sets the parent for a group

Parameters:

parent - Parent group

getParent

public CommandGroupMetadata getParent()

Gets the parent group which may be null

Returns:

Parent group, null if a top level group

toString

public String toString()

Overrides:

toString in class Object