Module com.adventure

Package com.adventure.commands

Class CommandMetadata

java.lang.Object

com.adventure.commands.CommandMetadata

public class CommandMetadata
extends Object

Object that stores metadata for a specific command.

Constructor Summary

Constructors

Constructor	Description
CommandMetadata(Class<? extends Command> commandClass)	Constructs a new metadata object with an empty description.
CommandMetadata(Class<? extends Command> commandClass, String description)	Constructs a new metadata object.

Method Summary

Modifier and Type	Method	Description
Class<? extends Command>	getCommandClass()	Command class getter.
String	getDescription()	Command description getter.
void	setDescription(String description)	Sets the description for the command.

Methods inherited from class java.lang.Object

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

Constructor Details

CommandMetadata

public CommandMetadata(Class<? extends Command> commandClass,
 String description)

Constructs a new metadata object.

Parameters:

commandClass - Class of the target command.

description - Brief command description.

CommandMetadata

public CommandMetadata(Class<? extends Command> commandClass)

Constructs a new metadata object with an empty description.

Parameters:

commandClass - Class if the target command.

Method Details

getCommandClass

public Class<? extends Command> getCommandClass()

Command class getter.

Returns:

Target command class.

getDescription

public String getDescription()

Command description getter.

Returns:

Target command description.

setDescription

public void setDescription(String description)

Sets the description for the command.

Parameters:

description - New target command description.