org.jboss.forge.ui.util

Class Metadata

java.lang.Object

org.jboss.forge.ui.util.Metadata

All Implemented Interfaces:

UICommandMetadata

public class Metadata
extends Object
implements UICommandMetadata

Author:

Lincoln Baxter, III

Constructor Summary

Constructors

Constructor and Description
Metadata(Class<? extends UICommand> type)

Method Summary

Methods

Modifier and Type	Method and Description
Metadata	category(UICategory category)
Metadata	description(String description)
Metadata	docLocation(URL docLocation)
static Metadata	forCommand(Class<? extends UICommand> type)
UICategory	getCategory()
String	getDescription()
URL	getDocLocation() Returns the location of the documentation of this command
String	getName()
Metadata	name(String name)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Metadata

public Metadata(Class<? extends UICommand> type)

Method Detail

forCommand

public static Metadata forCommand(Class<? extends UICommand> type)

name

public Metadata name(String name)

description

public Metadata description(String description)

category

public Metadata category(UICategory category)

docLocation

public Metadata docLocation(URL docLocation)

getName

public String getName()

Specified by:

getName in interface UICommandMetadata

getDescription

public String getDescription()

Specified by:

getDescription in interface UICommandMetadata

getCategory

public UICategory getCategory()

Specified by:

getCategory in interface UICommandMetadata

getDocLocation

public URL getDocLocation()

Description copied from interface: UICommandMetadata

Returns the location of the documentation of this command

Specified by:

getDocLocation in interface UICommandMetadata

Returns:

null if no documentation was found

toString

public String toString()

Overrides:

toString in class Object