Package cloud.commandframework.arguments.standard

Class LongArgument<C>

java.lang.Object

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

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

All Implemented Interfaces:

CloudKeyHolder<Long>, Comparable<CommandArgument<?,?>>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	LongArgument.Builder<C>
static final class	LongArgument.LongParseException
static final class	LongArgument.LongParser<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 LongArgument.Builder<C>	builder(@NonNull String name)	Create a new LongArgument.Builder.
long	getMax()	Get the maximum accepted long that could have been parsed
long	getMin()	Get the minimum accepted long that could have been parsed
static <C> @NonNull LongArgument.Builder<C>	newBuilder(@NonNull String name)	Deprecated. prefer builder(String)
static <C> @NonNull CommandArgument<C,Long>	of(@NonNull String name)	Create a new required LongArgument.
static <C> @NonNull CommandArgument<C,Long>	optional(@NonNull String name)	Create a new optional LongArgument.
static <C> @NonNull CommandArgument<C,Long>	optional(@NonNull String name, long defaultNum)	Create a new optional LongArgument 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 LongArgument.Builder<C> builder(@NonNull String name)

Create a new LongArgument.Builder.

Type Parameters:

C - sender type

Parameters:

name - argument name

Returns:

new LongArgument.Builder

Since:

1.8.0

newBuilder

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

Create a new required LongArgument.

Type Parameters:

C - Command sender type

Parameters:

name - Argument name

Returns:

Created argument

optional

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

Create a new optional LongArgument.

Type Parameters:

C - Command sender type

Parameters:

name - Argument name

Returns:

Created argument

optional

public static <C> @NonNull CommandArgument<C,Long> optional(@NonNull String name,
 long defaultNum)

Create a new optional LongArgument with the specified default value.

Type Parameters:

C - Command sender type

Parameters:

name - Argument name

defaultNum - Default num

Returns:

Created argument

getMin

public long getMin()

Get the minimum accepted long that could have been parsed

Returns:

Minimum long

getMax

public long getMax()

Get the maximum accepted long that could have been parsed

Returns:

Maximum long