com.github.ajalt.clikt.core

Interface GroupableOption

All Superinterfaces:

Option

All Known Subinterfaces:

OptionDelegate<T>

All Known Implementing Classes:

FlagOption, OptionWithValues

public GroupableOption
extends Option

An option that can be added to a interface ParameterGroup

See Also:

interface ParameterGroup

Nested Class Summary

Nested classes/interfaces inherited from interface com.github.ajalt.clikt.parameters.options.Option

Option.DefaultImpls

Method Summary

Modifier and Type	Method and Description
java.lang.String	getGroupName() The name of the group, or null if this option should not be grouped in the help output.
ParameterGroup	getParameterGroup() The group that this option belongs to, or null. Set by the group.
void	setGroupName(java.lang.String p) The name of the group, or null if this option should not be grouped in the help output.
void	setParameterGroup(ParameterGroup p) The group that this option belongs to, or null. Set by the group.

Methods inherited from interface com.github.ajalt.clikt.parameters.options.Option

finalize, getCompletionCandidates, getHelp, getHelpTags, getHidden, getMetavar, getNames, getNvalues, getParameterHelp, getParser, getSecondaryNames, postValidate

Method Detail

getParameterGroup

@Nullable
ParameterGroup getParameterGroup()

The group that this option belongs to, or null. Set by the group.

setParameterGroup

void setParameterGroup(@Nullable
                       ParameterGroup p)

The group that this option belongs to, or null. Set by the group.

getGroupName

@Nullable
java.lang.String getGroupName()

The name of the group, or null if this option should not be grouped in the help output.

setGroupName

void setGroupName(@Nullable
                  java.lang.String p)

The name of the group, or null if this option should not be grouped in the help output.