Package org.incendo.cloud.parser.flag

Class CommandFlag<T>

java.lang.Object

org.incendo.cloud.parser.flag.CommandFlag<T>

Type Parameters:

T - Command component type. Void is used when no component is present.

@API(status=STABLE)
public final class CommandFlag<T>
extends Object

A flag is an optional command component that may have an associated parser, and is identified by its name. Essentially, it's a mixture of a command literal and an optional variable command component.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CommandFlag.Builder<C,T>
static enum	CommandFlag.FlagMode

Method Summary

Modifier and Type	Method	Description
@NonNull Collection<@NonNull String>	aliases()	Returns the flag aliases, not including the name().
static <C> @NonNull CommandFlag.Builder<C,Void>	builder(@NonNull String name)	Create a new CommandFlag.Builder.
@Nullable CommandComponent<?>	commandComponent()	Returns the command component, if this is a value flag.
@NonNull Description	description()	Returns the flag description.
boolean	equals(Object o)
int	hashCode()
@NonNull CommandFlag.FlagMode	mode()	Returns the mode of this flag.
@NonNull String	name()	Returns the name of the flag.
Permission	permission()	Returns the permission required to use this flag, if it exists.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

builder

@API(status=STABLE)
public static <C>
@NonNull CommandFlag.Builder<C,Void> builder(@NonNull String name)

Create a new CommandFlag.Builder.

Type Parameters:

C - command sender type

Parameters:

name - flag name

Returns:

new CommandFlag.Builder

name

public @NonNull String name()

Returns the name of the flag.

Returns:

flag name

aliases

public @NonNull Collection<@NonNull String> aliases()

Returns the flag aliases, not including the name().

Returns:

flag aliases

mode

@API(status=STABLE)
public @NonNull CommandFlag.FlagMode mode()

Returns the mode of this flag.

Returns:

the flag mode

description

@API(status=STABLE)
public @NonNull Description description()

Returns the flag description.

Returns:

flag description

commandComponent

@API(status=STABLE)
public @Nullable CommandComponent<?> commandComponent()

Returns the command component, if this is a value flag.

Returns:

command component, or null if this is a presence flag

permission

@API(status=STABLE)
public Permission permission()

Returns the permission required to use this flag, if it exists.

Returns:

Command permission, or null

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object