Package cloud.commandframework
Interface ArgumentDescription
-
- All Known Implementing Classes:
Description
public interface ArgumentDescriptionA description for aCommandArgument- Since:
- 1.4.0
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description static @NonNull ArgumentDescriptionempty()Get an empty command description.@NonNull java.lang.StringgetDescription()Get the plain-text description.default booleanisEmpty()Get whether or not this description contains contents.static @NonNull ArgumentDescriptionof(@NonNull java.lang.String string)Create a command description instance.
-
-
-
Method Detail
-
empty
static @NonNull ArgumentDescription empty()
Get an empty command description.- Returns:
- Command description
-
of
static @NonNull ArgumentDescription of(@NonNull java.lang.String string)
Create a command description instance.- Parameters:
string- Command description- Returns:
- Created command description
-
getDescription
@NonNull java.lang.String getDescription()
Get the plain-text description.- Returns:
- Command description
-
isEmpty
default boolean isEmpty()
Get whether or not this description contains contents.- Returns:
- if this description is empty or not
-
-