Package cloud.commandframework.arguments.standard

Class CharArgument<C>

java.lang.Object

cloud.commandframework.arguments.CommandArgument<C,Character>

cloud.commandframework.arguments.standard.CharArgument<C>

All Implemented Interfaces:

CloudKeyHolder<Character>, Comparable<CommandArgument<?,?>>

@API(status=STABLE)
public final class CharArgument<C>
extends CommandArgument<C,Character>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CharArgument.Builder<C>
static final class	CharArgument.CharacterParser<C>
static final class	CharArgument.CharParseException	Char parse exception

Nested classes/interfaces inherited from class cloud.commandframework.arguments.CommandArgument

CommandArgument.TypedBuilder<C,T,B extends CommandArgument.Builder<C,T>>

Method Summary

Modifier and Type	Method	Description
static <C> @NonNull CharArgument.Builder<C>	newBuilder(@NonNull String name)	Create a new builder
static <C> @NonNull CommandArgument<C,Character>	of(@NonNull String name)	Create a new required command argument
static <C> @NonNull CommandArgument<C,Character>	optional(@NonNull String name)	Create a new optional command argument
static <C> @NonNull CommandArgument<C,Character>	optional(@NonNull String name, @NonNull String defaultNum)	Create a new required command argument with a default value

Methods inherited from class cloud.commandframework.arguments.CommandArgument

addPreprocessor, compareTo, copy, equals, getDefaultDescription, getDefaultValue, getKey, getName, getOwningCommand, getParser, getSuggestionsProvider, getValueType, hasDefaultValue, hashCode, isArgumentRegistered, isRequired, ofType, ofType, preprocess, setArgumentRegistered, setOwningCommand, toString

Methods inherited from class java.lang.Object

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

Method Details

newBuilder

public static <C> @NonNull CharArgument.Builder<C> newBuilder(@NonNull String name)

Create a new builder

Type Parameters:

C - Command sender type

Parameters:

name - Name of the argument

Returns:

Created builder

of

public static <C>
@NonNull CommandArgument<C,Character> of(@NonNull String name)

Create a new required command argument

Type Parameters:

C - Command sender type

Parameters:

name - Argument name

Returns:

Created argument

optional

public static <C>
@NonNull CommandArgument<C,Character> optional(@NonNull String name)

Create a new optional command argument

Type Parameters:

C - Command sender type

Parameters:

name - Argument name

Returns:

Created argument

optional

public static <C>
@NonNull CommandArgument<C,Character> optional(@NonNull String name,
 @NonNull String defaultNum)

Create a new required command argument with a default value

Type Parameters:

C - Command sender type

Parameters:

name - Argument name

defaultNum - Default num

Returns:

Created argument