Package cloud.commandframework.arguments.standard

Class DurationArgument<C>

java.lang.Object

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

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

Type Parameters:

C - sender type

All Implemented Interfaces:

CloudKeyHolder<Duration>, Comparable<CommandArgument<?,?>>

@API(status=STABLE,
     since="1.7.0")
public final class DurationArgument<C>
extends CommandArgument<C,Duration>

Parses Duration from a 1d2h3m4s format.

Since:

1.7.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DurationArgument.Builder<C>	Builder for DurationArgument.
static final class	DurationArgument.DurationParseException	Failure exception for DurationArgument.Parser.
static final class	DurationArgument.Parser<C>	Parser for Duration.

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 DurationArgument.Builder<C>	builder(@NonNull String name)	Create a new DurationArgument.Builder.
static <C> @NonNull DurationArgument<C>	of(@NonNull String name)	Create a new required DurationArgument.
static <C> @NonNull DurationArgument<C>	optional(@NonNull String name)	Create a new optional DurationArgument.
static <C> @NonNull DurationArgument<C>	optional(@NonNull String name, @NonNull String defaultDuration)	Create a new optional DurationArgument with the specified default value.
static <C> @NonNull DurationArgument<C>	optional(@NonNull String name, @NonNull Duration defaultDuration)	Create a new optional DurationArgument 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

public static <C>
@NonNull DurationArgument.Builder<C> builder(@NonNull String name)

Create a new DurationArgument.Builder.

Type Parameters:

C - sender type

Parameters:

name - argument name

Returns:

new builder

Since:

1.7.0

of

public static <C> @NonNull DurationArgument<C> of(@NonNull String name)

Create a new required DurationArgument.

Type Parameters:

C - sender type

Parameters:

name - argument name

Returns:

built argument

Since:

1.7.0

optional

public static <C> @NonNull DurationArgument<C> optional(@NonNull String name)

Create a new optional DurationArgument.

Type Parameters:

C - sender type

Parameters:

name - argument name

Returns:

built argument

Since:

1.7.0

optional

public static <C> @NonNull DurationArgument<C> optional(@NonNull String name,
 @NonNull String defaultDuration)

Create a new optional DurationArgument with the specified default value.

Type Parameters:

C - sender type

Parameters:

name - argument name

defaultDuration - default duration

Returns:

built argument

Since:

1.7.0

optional

public static <C> @NonNull DurationArgument<C> optional(@NonNull String name,
 @NonNull Duration defaultDuration)

Create a new optional DurationArgument with the specified default value.

Type Parameters:

C - sender type

Parameters:

name - argument name

defaultDuration - default duration

Returns:

built argument

Since:

1.7.0