Package cloud.commandframework.arguments.standard

Class ByteArgument<C>

java.lang.Object

cloud.commandframework.arguments.CommandArgument<C,java.lang.Byte>

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

All Implemented Interfaces:

CloudKeyHolder<java.lang.Byte>, java.lang.Comparable<CommandArgument<?,?>>

public final class ByteArgument<C>
extends CommandArgument<C,java.lang.Byte>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ByteArgument.Builder<C>
static class	ByteArgument.ByteParseException	Byte parse exception
static class	ByteArgument.ByteParser<C>

Method Summary

Modifier and Type	Method	Description
byte	getMax()	Get the maximum accepted byteeger that could have been parsed
byte	getMin()	Get the minimum accepted byteeger that could have been parsed
static <C> @NonNull ByteArgument.Builder<C>	newBuilder(@NonNull java.lang.String name)	Create a new builder
static <C> @NonNull CommandArgument<C,java.lang.Byte>	of(@NonNull java.lang.String name)	Create a new required command argument
static <C> @NonNull CommandArgument<C,java.lang.Byte>	optional(@NonNull java.lang.String name)	Create a new optional command argument
static <C> @NonNull CommandArgument<C,java.lang.Byte>	optional(@NonNull java.lang.String name, byte 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 Detail

newBuilder

public static <C> @NonNull ByteArgument.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.Byte> 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.Byte> 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.Byte> optional(@NonNull java.lang.String name,
                                                                            byte 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

getMin

public byte getMin()

Get the minimum accepted byteeger that could have been parsed

Returns:

Minimum byteeger

getMax

public byte getMax()

Get the maximum accepted byteeger that could have been parsed

Returns:

Maximum byteeger