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 java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
private ArgumentsMetadata	arguments
private java.util.List<OptionMetadata>	commandOptions
private OptionMetadata	defaultOption
private java.lang.String	description
private java.util.List<OptionMetadata>	globalOptions
private java.util.List<java.lang.String>	groupNames
private java.util.List<OptionMetadata>	groupOptions
private java.util.List<Group>	groups
private boolean	hidden
private java.util.List<Accessor>	metadataInjections
private java.lang.String	name
private java.util.List<HelpSection>	sections
private java.lang.Class<?>	type

Constructor Summary

Constructors

Constructor

Description

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object other)
java.util.List<OptionMetadata>	getAllOptions()
ArgumentsMetadata	getArguments()
java.util.List<OptionMetadata>	getCommandOptions()
OptionMetadata	getDefaultOption()
java.lang.String	getDescription()
java.util.List<OptionMetadata>	getGlobalOptions()
java.util.List<java.lang.String>	getGroupNames()
java.util.List<OptionMetadata>	getGroupOptions()
java.util.List<Group>	getGroups()
java.util.List<HelpSection>	getHelpSections()	Gets the additional help sections
java.util.List<Accessor>	getMetadataInjections()
java.lang.String	getName()
java.lang.Class<?>	getType()	Gets the command type i.e.
boolean	isHidden()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

name

private final java.lang.String name

description

private final java.lang.String description

hidden

private final boolean hidden

globalOptions

private final java.util.List<OptionMetadata> globalOptions

groupOptions

private final java.util.List<OptionMetadata> groupOptions

commandOptions

private final java.util.List<OptionMetadata> commandOptions

defaultOption

private final OptionMetadata defaultOption

arguments

private final ArgumentsMetadata arguments

metadataInjections

private final java.util.List<Accessor> metadataInjections

type

private final java.lang.Class<?> type

groupNames

private final java.util.List<java.lang.String> groupNames

groups

private final java.util.List<Group> groups

sections

private final java.util.List<HelpSection> sections

Constructor Detail

CommandMetadata

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

Method Detail

getName

public java.lang.String getName()

getDescription

public java.lang.String getDescription()

isHidden

public boolean isHidden()

getAllOptions

public java.util.List<OptionMetadata> getAllOptions()

getHelpSections

public java.util.List<HelpSection> getHelpSections()

Gets the additional help sections

Returns:

Help sections

getGlobalOptions

public java.util.List<OptionMetadata> getGlobalOptions()

getGroupOptions

public java.util.List<OptionMetadata> getGroupOptions()

getCommandOptions

public java.util.List<OptionMetadata> getCommandOptions()

getDefaultOption

public OptionMetadata getDefaultOption()

getArguments

public ArgumentsMetadata getArguments()

getMetadataInjections

public java.util.List<Accessor> getMetadataInjections()

getType

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

getGroups

public java.util.List<Group> getGroups()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object