com.xmlmind.xmledit.control

Class CommandEntry

java.lang.Object

com.xmlmind.util.PropertySet

com.xmlmind.xmledit.control.CommandEntry

public final class CommandEntry
extends PropertySet

Utility class: a general purpose command/parameter pair.

Field Summary

Fields

Modifier and Type	Field and Description
Command	command The command name; null if the command has been specified by its instance.
String	commandName The command; null if the command has been specified by its name.
String	description Text describing this entry; may be null.
static CommandEntry[]	EMPTY_LIST A ready-to-use empty array of command entries.
String	parameter The command parameter; may be null.

Fields inherited from class com.xmlmind.util.PropertySet

properties

Constructor Summary

Constructors

Constructor and Description
CommandEntry(Command command, String parameter, String description) Constructs a command/parameter pair.
CommandEntry(String commandName, String parameter, String description) Constructs a command/parameter pair.

Method Summary

Modifier and Type	Method and Description
CommandEntry	copy() Makes a deep copy of this command entry.
boolean	equals(Object other)
Command	getCommand(CommandRegistry registry) Convenience method invoking CommandRegistry.getCommand(java.lang.String).
String	getCommandLabel(CommandRegistry registry) Convenience method invoking CommandRegistry.getLabel(com.xmlmind.xmledit.control.Command).
String	getCommandName(CommandRegistry registry) Convenience method invoking CommandRegistry.getName(com.xmlmind.xmledit.control.Command).
String	toString()
String	toString(CommandRegistry registry)

Methods inherited from class com.xmlmind.util.PropertySet

getProperties, getProperty, getPropertyCount, hasProperty, putProperties, putProperty, removeAllProperties, removeProperty

Methods inherited from class java.lang.Object

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

Field Detail

commandName

public final String commandName

The command; null if the command has been specified by its name.

One of commandName and command is not null. The other field is null.

command

public final Command command

The command name; null if the command has been specified by its instance.

One of commandName and command is not null. The other field is null.

parameter

public final String parameter

The command parameter; may be null.

description

public final String description

Text describing this entry; may be null.

EMPTY_LIST

public static final CommandEntry[] EMPTY_LIST

A ready-to-use empty array of command entries.

Constructor Detail

CommandEntry

public CommandEntry(String commandName,
                    String parameter,
                    String description)

Constructs a command/parameter pair.

Parameters:

commandName - the command name

parameter - the command parameter; may be null

description - a description; may be null

CommandEntry

public CommandEntry(Command command,
                    String parameter,
                    String description)

Constructs a command/parameter pair.

Parameters:

command - the command

parameter - the command parameter; may be null

description - a description; may be null

Method Detail

copy

public CommandEntry copy()

Makes a deep copy of this command entry.

Returns:

the copy or null if how to copy the referenced command cannot be determined

getCommand

public Command getCommand(CommandRegistry registry)

Convenience method invoking CommandRegistry.getCommand(java.lang.String).

getCommandName

public String getCommandName(CommandRegistry registry)

Convenience method invoking CommandRegistry.getName(com.xmlmind.xmledit.control.Command).

getCommandLabel

public String getCommandLabel(CommandRegistry registry)

Convenience method invoking CommandRegistry.getLabel(com.xmlmind.xmledit.control.Command).

equals

public boolean equals(Object other)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(CommandRegistry registry)