Module com.github.rvesse.airline

Package com.github.rvesse.airline.model

Class CommandMetadata

java.lang.Object

com.github.rvesse.airline.model.CommandMetadata

public class CommandMetadata
extends Object

Constructor Summary

Constructors

Constructor	Description
CommandMetadata(String name, String description, boolean hidden, Iterable<OptionMetadata> globalOptions, Iterable<OptionMetadata> groupOptions, Iterable<OptionMetadata> commandOptions, OptionMetadata defaultOption, ArgumentsMetadata arguments, Iterable<Accessor> metadataInjections, Class<?> type, List<String> groupNames, List<Group> groups, List<HelpSection> sections)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
List<OptionMetadata>	getAllOptions()
ArgumentsMetadata	getArguments()
List<OptionMetadata>	getCommandOptions()
OptionMetadata	getDefaultOption()
String	getDescription()
List<OptionMetadata>	getGlobalOptions()
List<String>	getGroupNames()
List<OptionMetadata>	getGroupOptions()
List<Group>	getGroups()
List<HelpSection>	getHelpSections()	Gets the additional help sections
List<Accessor>	getMetadataInjections()
String	getName()
Class<?>	getType()	Gets the command type i.e. the class that will be instantiated to represent and execute this command
boolean	isHidden()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

CommandMetadata

public CommandMetadata(String name,
 String description,
 boolean hidden,
 Iterable<OptionMetadata> globalOptions,
 Iterable<OptionMetadata> groupOptions,
 Iterable<OptionMetadata> commandOptions,
 OptionMetadata defaultOption,
 ArgumentsMetadata arguments,
 Iterable<Accessor> metadataInjections,
 Class<?> type,
 List<String> groupNames,
 List<Group> groups,
 List<HelpSection> sections)

Method Details

getName

public String getName()

getDescription

public String getDescription()

isHidden

public boolean isHidden()

getAllOptions

public List<OptionMetadata> getAllOptions()

getHelpSections

public List<HelpSection> getHelpSections()

Gets the additional help sections

Returns:

Help sections

getGlobalOptions

public List<OptionMetadata> getGlobalOptions()

getGroupOptions

public List<OptionMetadata> getGroupOptions()

getCommandOptions

public List<OptionMetadata> getCommandOptions()

getDefaultOption

public OptionMetadata getDefaultOption()

getArguments

public ArgumentsMetadata getArguments()

getMetadataInjections

public List<Accessor> getMetadataInjections()

getType

public Class<?> getType()

Gets the command type i.e. the class that will be instantiated to represent and execute this command

Returns:

Command type

getGroupNames

public List<String> getGroupNames()

getGroups

public List<Group> getGroups()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object