Package org.incendo.cloud.description

Interface CommandDescription

All Superinterfaces:

Describable

@Immutable
@API(status=STABLE)
public interface CommandDescription
extends Describable

Method Summary

Modifier and Type	Method	Description
static @NonNull CommandDescription	commandDescription(@NonNull String description)	Returns a new command description using the given description.
static @NonNull CommandDescription	commandDescription(@NonNull String description, @NonNull String verboseDescription)	Returns a new command description using the given description and verboseDescription.
static @NonNull CommandDescription	commandDescription(@NonNull Description description)	Returns a new command description using the given description.
static @NonNull CommandDescription	commandDescription(@NonNull Description description, @NonNull Description verboseDescription)	Returns a new command description using the given description and verboseDescription.
@NonNull Description	description()	Returns the command description.
static @NonNull CommandDescription	empty()	Returns an empty command description.
default boolean	isEmpty()	Returns whether the description is empty.
@NonNull Description	verboseDescription()	Returns the verbose version of the command description.

Method Details

empty

static @NonNull CommandDescription empty()

Returns an empty command description.

Both description() and verboseDescription() will return Description.empty().

Returns:

the description instance

commandDescription

static @NonNull CommandDescription commandDescription(@NonNull Description description,
 @NonNull Description verboseDescription)

Returns a new command description using the given description and verboseDescription.

Parameters:

description - the command description

verboseDescription - the verbose command description

Returns:

the description instance

commandDescription

static @NonNull CommandDescription commandDescription(@NonNull Description description)

Returns a new command description using the given description.

The verboseDescription() will return the same value as description().

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 given description and verboseDescription.

Parameters:

description - the command description

verboseDescription - the verbose command description

Returns:

the description instance

commandDescription

static @NonNull CommandDescription commandDescription(@NonNull String description)

Returns a new command description using the given description.

The verboseDescription() will return the same value as description().

Parameters:

description - the command description

Returns:

the description instance

description

@NonNull Description description()

Returns the command description.

Specified by:

description in interface Describable

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()