org.jboss.forge.addon.ui.metadata

Interface UICommandMetadata

All Known Implementing Classes:

Metadata

public interface UICommandMetadata

Describes a UICommand implementation

Author:

Lincoln Baxter, III, George Gastaldi

Field Summary

Fields

Modifier and Type	Field and Description
static String	NO_DESCRIPTION Label used when no description is set

Method Summary

Modifier and Type	Method and Description
UICategory	getCategory() Returns the UICategory of the corresponding UICommand.
String	getDeprecatedMessage() Returns a deprecated message to be displayed when isDeprecated() returns true.
String	getDescription() Returns the description of the corresponding UICommand.
URL	getDocLocation() Returns the location of the documentation of the corresponding UICommand.
String	getName() Return the name of the corresponding UICommand.
Class<?>	getType() Returns the Class of the corresponding UICommand.
boolean	isDeprecated() Returns if this command is discouraged from using, typically because it is dangerous, or because a better alternative exists

Field Detail

NO_DESCRIPTION

static final String NO_DESCRIPTION

Label used when no description is set

See Also:

Constant Field Values

Method Detail

getType

Class<?> getType()

Returns the Class of the corresponding UICommand.

getName

String getName()

Return the name of the corresponding UICommand.

getDescription

String getDescription()

Returns the description of the corresponding UICommand.

getCategory

UICategory getCategory()

Returns the UICategory of the corresponding UICommand.

getDocLocation

URL getDocLocation()

Returns the location of the documentation of the corresponding UICommand. (can be null.)

isDeprecated

boolean isDeprecated()

Returns if this command is discouraged from using, typically because it is dangerous, or because a better alternative exists

getDeprecatedMessage

String getDeprecatedMessage()

Returns a deprecated message to be displayed when isDeprecated() returns true.