Package org.incendo.cloud.description
Interface CommandDescription
- All Superinterfaces:
Describable
-
Method Summary
Modifier and TypeMethodDescriptionstatic @NonNull CommandDescriptioncommandDescription(@NonNull String description) Returns a new command description using the givendescription.static @NonNull CommandDescriptioncommandDescription(@NonNull String description, @NonNull String verboseDescription) Returns a new command description using the givendescriptionandverboseDescription.static @NonNull CommandDescriptioncommandDescription(@NonNull Description description) Returns a new command description using the givendescription.static @NonNull CommandDescriptioncommandDescription(@NonNull Description description, @NonNull Description verboseDescription) Returns a new command description using the givendescriptionandverboseDescription.Returns the command description.static @NonNull CommandDescriptionempty()Returns an empty command description.default booleanisEmpty()Returns whether the description is empty.Returns the verbose version of the command description.
-
Method Details
-
empty
Returns an empty command description.Both
description()andverboseDescription()will returnDescription.empty().- Returns:
- the description instance
-
commandDescription
static @NonNull CommandDescription commandDescription(@NonNull Description description, @NonNull Description verboseDescription) Returns a new command description using the givendescriptionandverboseDescription.- Parameters:
description- the command descriptionverboseDescription- the verbose command description- Returns:
- the description instance
-
commandDescription
Returns a new command description using the givendescription.The
verboseDescription()will return the same value asdescription().- Parameters:
description- the command description- Returns:
- the description instance
-
commandDescription
static @NonNull CommandDescription commandDescription(@NonNull String description, @NonNull String verboseDescription) Returns a new command description using the givendescriptionandverboseDescription.- Parameters:
description- the command descriptionverboseDescription- the verbose command description- Returns:
- the description instance
-
commandDescription
Returns a new command description using the givendescription.The
verboseDescription()will return the same value asdescription().- Parameters:
description- the command description- Returns:
- the description instance
-
description
@NonNull Description description()Returns the command description.- Specified by:
descriptionin interfaceDescribable- Returns:
- the command description
-
verboseDescription
@NonNull Description verboseDescription()Returns the verbose version of the command description.- Returns:
- the verbose command description
-
isEmpty
default boolean isEmpty()Returns whether the description is empty.- Returns:
- whether the description equals
Description.empty()
-