Package cloud.commandframework

Class Description

java.lang.Object

cloud.commandframework.Description

All Implemented Interfaces:

ArgumentDescription

@Deprecated
@API(status=DEPRECATED,
     since="1.4.0")
public final class Description
extends Object
implements ArgumentDescription

Deprecated.

to become package-private since 1.4.0. Use ArgumentDescription instead.

CommandArgument description

Method Summary

Modifier and Type	Method	Description
static @NonNull Description	empty()	Deprecated. for removal since 1.4.0.
@NonNull String	getDescription()	Deprecated. Get the command description
static @NonNull Description	of(@NonNull String string)	Deprecated. for removal since 1.4.0.
@NonNull String	toString()	Deprecated. Get the command description

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface cloud.commandframework.ArgumentDescription

isEmpty

Method Details

empty

@Deprecated
public static @NonNull Description empty()

Deprecated.

for removal since 1.4.0. See ArgumentDescription.empty()

Get an empty command description

Returns:

Command description

of

@Deprecated
public static @NonNull Description of(@NonNull String string)

Deprecated.

for removal since 1.4.0. See ArgumentDescription.of(String)

Create a command description instance

Parameters:

string - Command description

Returns:

Created command description

getDescription

public @NonNull String getDescription()

Deprecated.

Get the command description

Specified by:

getDescription in interface ArgumentDescription

Returns:

Command description

toString

public @NonNull String toString()

Deprecated.

Get the command description

Overrides:

toString in class Object

Returns:

Command description