Package net.minestom.server.command.builder.arguments

Class ArgumentBoolean

java.lang.Object

net.minestom.server.command.builder.arguments.Argument<Boolean>

net.minestom.server.command.builder.arguments.ArgumentBoolean

public class ArgumentBoolean
extends Argument<Boolean>

Represents a boolean value.

Example: true

Field Summary

Fields

Modifier and Type	Field	Description
static final int	NOT_BOOLEAN_ERROR

Fields inherited from class net.minestom.server.command.builder.arguments.Argument

allowSpace, suggestionType, useRemaining

Constructor Summary

Constructors

Constructor	Description
ArgumentBoolean(String id)

Method Summary

Modifier and Type	Method	Description
@NotNull Boolean	parse(@NotNull CommandSender sender, @NotNull String input)	Parses the given input, and throw an ArgumentSyntaxException if the input cannot be converted to T
ArgumentParserType	parser()
String	toString()

Methods inherited from class net.minestom.server.command.builder.arguments.Argument

allowSpace, equals, filter, getCallback, getDefaultValue, getId, getSuggestionCallback, hasErrorCallback, hashCode, hasSuggestion, isOptional, map, map, nodeProperties, parse, setCallback, setDefaultValue, setDefaultValue, setDefaultValue, setSuggestionCallback, suggestionType, useRemaining

Methods inherited from class java.lang.Object

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

Field Details

NOT_BOOLEAN_ERROR

public static final int NOT_BOOLEAN_ERROR

See Also:

• Constant Field Values

Constructor Details

ArgumentBoolean

public ArgumentBoolean(String id)

Method Details

parse

@NotNull
public @NotNull Boolean parse(@NotNull
 @NotNull CommandSender sender,
 @NotNull
 @NotNull String input)
                       throws ArgumentSyntaxException

Description copied from class: Argument

Parses the given input, and throw an ArgumentSyntaxException if the input cannot be converted to T

Specified by:

parse in class Argument<Boolean>

Parameters:

input - the argument to parse

Returns:

the parsed argument

Throws:

ArgumentSyntaxException - if value is not valid

parser

public ArgumentParserType parser()

Specified by:

parser in class Argument<Boolean>

toString

public String toString()

Overrides:

toString in class Object