Package cloud.commandframework.arguments.standard

Class BooleanArgument<C>

java.lang.Object

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

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

All Implemented Interfaces:

CloudKeyHolder<Boolean>, Comparable<CommandArgument<?,?>>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BooleanArgument.BooleanParseException	Boolean parse exception
static final class	BooleanArgument.BooleanParser<C>
static final class	BooleanArgument.Builder<C>

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 BooleanArgument.Builder<C>	builder(@NonNull String name)	Create a new BooleanArgument.Builder.
boolean	isLiberal()	Get the liberal boolean
static <C> @NonNull BooleanArgument.Builder<C>	newBuilder(@NonNull String name)	Deprecated. prefer builder(String)
static <C> @NonNull CommandArgument<C,Boolean>	of(@NonNull String name)	Create a new required command argument
static <C> @NonNull CommandArgument<C,Boolean>	optional(@NonNull String name)	Create a new optional command argument
static <C> @NonNull CommandArgument<C,Boolean>	optional(@NonNull String name, boolean defaultBoolean)	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

builder

@API(status=STABLE,
     since="1.8.0")
public static <C>
@NonNull BooleanArgument.Builder<C> builder(@NonNull String name)

Create a new BooleanArgument.Builder.

Type Parameters:

C - sender type

Parameters:

name - argument name

Returns:

new BooleanArgument.Builder

Since:

1.8.0

newBuilder

@API(status=DEPRECATED,
     since="1.8.0")
@Deprecated
public static <C>
@NonNull BooleanArgument.Builder<C> newBuilder(@NonNull String name)

Deprecated.

prefer builder(String)

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,Boolean> 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,Boolean> 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,Boolean> optional(@NonNull String name,
 boolean defaultBoolean)

Create a new required command argument with a default value

Type Parameters:

C - Command sender type

Parameters:

name - Argument name

defaultBoolean - Default num

Returns:

Created argument

isLiberal

public boolean isLiberal()

Get the liberal boolean

Returns:

Liberal boolean