Package cloud.commandframework.arguments.standard

Class ByteArgument<C>

java.lang.Object

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

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

All Implemented Interfaces:

CloudKeyHolder<Byte>, Comparable<CommandArgument<?,?>>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ByteArgument.Builder<C>
static final class	ByteArgument.ByteParseException	Byte parse exception
static final class	ByteArgument.ByteParser<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 ByteArgument.Builder<C>	builder(@NonNull String name)	Create a new ByteArgument.Builder.
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 String name)	Deprecated. prefer builder(String)
static <C> @NonNull CommandArgument<C,Byte>	of(@NonNull String name)	Create a new required ByteArgument.
static <C> @NonNull CommandArgument<C,Byte>	optional(@NonNull String name)	Create a new optional ByteArgument.
static <C> @NonNull CommandArgument<C,Byte>	optional(@NonNull String name, byte defaultNum)	Create a new optional ByteArgument with the specified 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 ByteArgument.Builder<C> builder(@NonNull String name)

Create a new ByteArgument.Builder.

Type Parameters:

C - sender type

Parameters:

name - argument name

Returns:

new ByteArgument.Builder

Since:

1.8.0

newBuilder

@API(status=DEPRECATED,
     since="1.8.0")
@Deprecated
public static <C> @NonNull ByteArgument.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,Byte> of(@NonNull String name)

Create a new required ByteArgument.

Type Parameters:

C - Command sender type

Parameters:

name - Argument name

Returns:

Created argument

optional

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

Create a new optional ByteArgument.

Type Parameters:

C - Command sender type

Parameters:

name - Argument name

Returns:

Created argument

optional

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

Create a new optional ByteArgument with the specified 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