Class BooleanArgument<C>
- java.lang.Object
-
- cloud.commandframework.arguments.CommandArgument<C,java.lang.Boolean>
-
- cloud.commandframework.arguments.standard.BooleanArgument<C>
-
- All Implemented Interfaces:
java.lang.Comparable<CommandArgument<?,?>>
public final class BooleanArgument<C> extends CommandArgument<C,java.lang.Boolean>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
BooleanArgument.BooleanParseException
Boolean parse exceptionstatic class
BooleanArgument.BooleanParser<C>
static class
BooleanArgument.Builder<C>
-
Method Summary
Modifier and Type Method Description boolean
isLiberal()
Get the liberal booleanstatic <C> @NonNull BooleanArgument.Builder<C>
newBuilder(@NonNull java.lang.String name)
Create a new builderstatic <C> @NonNull CommandArgument<C,java.lang.Boolean>
of(@NonNull java.lang.String name)
Create a new required command argumentstatic <C> @NonNull CommandArgument<C,java.lang.Boolean>
optional(@NonNull java.lang.String name)
Create a new optional command argumentstatic <C> @NonNull CommandArgument<C,java.lang.Boolean>
optional(@NonNull java.lang.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, getDefaultValue, getName, getOwningCommand, getParser, getSuggestionsProvider, getValueType, hasDefaultValue, hashCode, isArgumentRegistered, isRequired, ofType, ofType, preprocess, setArgumentRegistered, setOwningCommand, toString
-
-
-
-
Method Detail
-
newBuilder
public static <C> @NonNull BooleanArgument.Builder<C> newBuilder(@NonNull java.lang.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,java.lang.Boolean> of(@NonNull java.lang.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,java.lang.Boolean> optional(@NonNull java.lang.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,java.lang.Boolean> optional(@NonNull java.lang.String name, boolean defaultBoolean)
Create a new required command argument with a default value- Type Parameters:
C
- Command sender type- Parameters:
name
- Argument namedefaultBoolean
- Default num- Returns:
- Created argument
-
isLiberal
public boolean isLiberal()
Get the liberal boolean- Returns:
- Liberal boolean
-
-