org.jboss.forge.addon.ui.util

Class Metadata

java.lang.Object

org.jboss.forge.addon.ui.util.Metadata

All Implemented Interfaces:

UICommandMetadata

public class Metadata
extends Object
implements UICommandMetadata

Author:

Lincoln Baxter, III

Field Summary

Fields inherited from interface org.jboss.forge.addon.ui.metadata.UICommandMetadata

NO_DESCRIPTION

Method Summary

Methods

Modifier and Type	Method and Description
Metadata	category(UICategory category) Set the UICategory of the corresponding UICommand.
Metadata	deprecated(boolean deprecated) Set the deprecated flag for this command
Metadata	deprecatedMessage(String deprecatedMessage) Set the deprecated message for this command
Metadata	description(String description) Set the description for the corresponding UICommand.
Metadata	docLocation(URL docLocation) Set the URL document location of the corresponding UICommand.
static Metadata	forCommand(Class<?> type) Create a new UICommandMetadata for the given UICommand type.
static Metadata	from(UICommandMetadata origin, Class<? extends UICommand> type) Create a new UICommandMetadata implementation from the given UICommandMetadata origin, and the given UICommand type.
UICategory	getCategory() Returns the UICategory of the corresponding UICommand.
String	getDeprecatedMessage() Returns a deprecated message to be displayed when UICommandMetadata.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
Metadata	name(String name) Set the name for the corresponding UICommand.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

from

public static Metadata from(UICommandMetadata origin,
            Class<? extends UICommand> type)

Create a new UICommandMetadata implementation from the given UICommandMetadata origin, and the given UICommand type.

forCommand

public static Metadata forCommand(Class<?> type)

Create a new UICommandMetadata for the given UICommand type.

name

public Metadata name(String name)

Set the name for the corresponding UICommand.

description

public Metadata description(String description)

Set the description for the corresponding UICommand.

category

public Metadata category(UICategory category)

Set the UICategory of the corresponding UICommand.

docLocation

public Metadata docLocation(URL docLocation)

Set the URL document location of the corresponding UICommand.

deprecated

public Metadata deprecated(boolean deprecated)

Set the deprecated flag for this command

deprecatedMessage

public Metadata deprecatedMessage(String deprecatedMessage)

Set the deprecated message for this command

getName

public String getName()

Description copied from interface: UICommandMetadata

Return the name of the corresponding UICommand.

Specified by:

getName in interface UICommandMetadata

getDescription

public String getDescription()

Description copied from interface: UICommandMetadata

Returns the description of the corresponding UICommand.

Specified by:

getDescription in interface UICommandMetadata

getCategory

public UICategory getCategory()

Description copied from interface: UICommandMetadata

Returns the UICategory of the corresponding UICommand.

Specified by:

getCategory in interface UICommandMetadata

getDocLocation

public URL getDocLocation()

Description copied from interface: UICommandMetadata

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

Specified by:

getDocLocation in interface UICommandMetadata

toString

public String toString()

Overrides:

toString in class Object

isDeprecated

public boolean isDeprecated()

Description copied from interface: UICommandMetadata

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

Specified by:

isDeprecated in interface UICommandMetadata

getDeprecatedMessage

public String getDeprecatedMessage()

Description copied from interface: UICommandMetadata

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

Specified by:

getDeprecatedMessage in interface UICommandMetadata

getType

public Class<?> getType()

Description copied from interface: UICommandMetadata

Returns the Class of the corresponding UICommand.

Specified by:

getType in interface UICommandMetadata