Class UserArgument<C>
java.lang.Object
cloud.commandframework.arguments.CommandArgument<C,org.pircbotx.User>
cloud.commandframework.pircbotx.arguments.UserArgument<C>
- Type Parameters:
C
- Command sender type
- All Implemented Interfaces:
cloud.commandframework.keys.CloudKeyHolder<org.pircbotx.User>
,Comparable<cloud.commandframework.arguments.CommandArgument<?,
?>>
public final class UserArgument<C>
extends cloud.commandframework.arguments.CommandArgument<C,org.pircbotx.User>
Command argument
that parses PircBotX users
- Since:
- 1.1.0
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
static final class
static final class
-
Method Summary
Modifier and TypeMethodDescriptionstatic <C> @NonNull UserArgument.Builder<C>
newBuilder
(@NonNull String name) Create a new user argument builderstatic <C> @NonNull cloud.commandframework.arguments.CommandArgument<C,
org.pircbotx.User> Create a new required user argumentstatic <C> @NonNull cloud.commandframework.arguments.CommandArgument<C,
org.pircbotx.User> Create a optional user argumentMethods 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
-
Method Details
-
newBuilder
Create a new user argument builder- Type Parameters:
C
- Command sender type- Parameters:
name
- Argument name- Returns:
- Builder instance
-
of
public static <C> @NonNull cloud.commandframework.arguments.CommandArgument<C,org.pircbotx.User> of(@NonNull String name) Create a new required user argument- Type Parameters:
C
- Command sender type- Parameters:
name
- Argument name- Returns:
- Argument instance
-
optional
public static <C> @NonNull cloud.commandframework.arguments.CommandArgument<C,org.pircbotx.User> optional(@NonNull String name) Create a optional user argument- Type Parameters:
C
- Command sender type- Parameters:
name
- Argument name- Returns:
- Argument instance
-