Package cloud.commandframework.bukkit.argument

Class NamespacedKeyArgument<C>

java.lang.Object

cloud.commandframework.arguments.CommandArgument<C,org.bukkit.NamespacedKey>

cloud.commandframework.bukkit.argument.NamespacedKeyArgument<C>

Type Parameters:

C - sender type

All Implemented Interfaces:

cloud.commandframework.keys.CloudKeyHolder<org.bukkit.NamespacedKey>, Comparable<cloud.commandframework.arguments.CommandArgument<?,?>>

public final class NamespacedKeyArgument<C>
extends cloud.commandframework.arguments.CommandArgument<C,org.bukkit.NamespacedKey>

cloud argument type that parses NamespacedKeys

Since:

1.7.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	NamespacedKeyArgument.Builder<C>	Builder for NamespacedKeyArgument.
static final class	NamespacedKeyArgument.NamespacedKeyParseException	Exception used when NamespacedKeyArgument.Parser fails.
static final class	NamespacedKeyArgument.Parser<C>	Parser for NamespacedKey.

Nested classes/interfaces inherited from class cloud.commandframework.arguments.CommandArgument

cloud.commandframework.arguments.CommandArgument.TypedBuilder<C extends Object,T extends Object,B extends cloud.commandframework.arguments.CommandArgument.Builder<C,T>>

Method Summary

Modifier and Type	Method	Description
static <C> @NonNull NamespacedKeyArgument.Builder<C>	builder(@NonNull String name)	Create a new NamespacedKeyArgument.Builder.
static <C> @NonNull NamespacedKeyArgument<C>	of(@NonNull String name)	Create a new required NamespacedKeyArgument.
static <C> @NonNull NamespacedKeyArgument<C>	optional(@NonNull String name)	Create a new optional NamespacedKeyArgument.
static <C> @NonNull NamespacedKeyArgument<C>	optional(@NonNull String name, @NonNull org.bukkit.NamespacedKey defulatValue)	Create a new optional NamespacedKeyArgument using the provided 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 NamespacedKeyArgument.Builder<C> builder(@NonNull String name)

Create a new NamespacedKeyArgument.Builder.

Type Parameters:

C - sender type

Parameters:

name - argument name

Returns:

builder instance

Since:

1.7.0

of

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

Create a new required NamespacedKeyArgument.

Type Parameters:

C - sender type

Parameters:

name - argument name

Returns:

argument instance

Since:

1.7.0

optional

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

Create a new optional NamespacedKeyArgument.

Type Parameters:

C - sender type

Parameters:

name - argument name

Returns:

argument instance

Since:

1.7.0

optional

public static <C> @NonNull NamespacedKeyArgument<C> optional(@NonNull String name,
 @NonNull org.bukkit.NamespacedKey defulatValue)

Create a new optional NamespacedKeyArgument using the provided default value.

Type Parameters:

C - sender type

Parameters:

name - argument name

defulatValue - default name

Returns:

argument instance

Since:

1.7.0