com.xmlmind.xmledit.control

Class CommandRegistry

java.lang.Object

com.xmlmind.xmledit.control.CommandRegistry

public final class CommandRegistry
extends Object

Registry of Commands.

Constructor Summary

Constructors

Constructor and Description
CommandRegistry()

Method Summary

Modifier and Type	Method and Description
CommandRegistry	copy(Console console) Returns a deep copy of this registry.
Command[]	getAllCommands(String namespace) Returns a array containing all the registered commands having specified namespace.
String[]	getAllLocalNames(String namespace) Returns a sorted array containing the local names of all the registered commands having specified namespace.
String[]	getAllNames() Returns a sorted array containing the names of all the registered commands having a null namespace.
Command	getCommand(String name) Returns command with specified name.
String[]	getDescription(Binding binding) Returns a 3-field description of specified binding.
String[][]	getDescriptions(Binding[] bindings) Returns descriptions for specified bindings.
String	getLabel(Command command) Returns a label (guaranteed to be non-null) for specified command.
String	getName(Command command) Returns name of specified command.
static CommandRegistry	getSharedInstance() Returns the shared instance of CommandRegistry.
boolean	isRegistered(String name) Returns true is command with specified name has been registered.
static String	joinName(String namespace, String localName) Joins specified namespace and specified local name in order to return a qualified name.
void	register(String name, Command command) Eagerly registers specified command under specified name.
void	register(String name, String className) Lazily registers specified command under specified name.
void	register(String name, String className, Command command) Registers specified command under specified name.
static void	setSharedInstance(CommandRegistry registry) Installs the shared instance of CommandRegistry.
static String[]	splitName(String name) Returns a 2-string array containing specified name split into a namespace and a local name.
String	toString()
boolean	unregister(String name) Unregisters command having specified name.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandRegistry

public CommandRegistry()

Method Detail

copy

public CommandRegistry copy(Console console)

Returns a deep copy of this registry.

Parameters:

console - used to print copy errors; may be null

Returns:

a copy of this registry

toString

public String toString()

Overrides:

toString in class Object

register

public void register(String name,
                     String className)

Lazily registers specified command under specified name.

Equivalent to register(name, className, null).

register

public void register(String name,
                     Command command)

Eagerly registers specified command under specified name.

Equivalent to register(name, null, command).

register

public void register(String name,
                     String className,
                     Command command)

Registers specified command under specified name.

Parameters:

name - name of command to be registered. May not be null or empty.

className - class of command to be registered. May be null is command is to be eagerly registered; otherwise may not be null or empty.

command - instance of command to be registered. May be null is command is to be lazily registered. className and command may not both be null.

splitName

public static String[] splitName(String name)

Returns a 2-string array containing specified name split into a namespace and a local name.

• splitName("{foo}bar") returns ["foo", "bar"].
• splitName("bar") returns [null, "bar"].
• splitName("{}bar") returns [null, "bar"].

See Also:

joinName(java.lang.String, java.lang.String)

joinName

public static String joinName(String namespace,
                              String localName)

Joins specified namespace and specified local name in order to return a qualified name. Examples:

• joinName("foo", "bar") returns "{foo}bar".
• joinName(null, "bar") returns "bar".
• joinName("", "bar") returns "bar".

See Also:

splitName(java.lang.String)

unregister

public boolean unregister(String name)

Unregisters command having specified name.

Parameters:

name - name of command to be unregistered.

Returns:

true if command has been unregistered; false if specified command is unknown

getCommand

public Command getCommand(String name)

Returns command with specified name. Returns null if such command has not been registered or if specified command has been lazily registered and instantiating the class does not work.

isRegistered

public boolean isRegistered(String name)

Returns true is command with specified name has been registered. Returns false otherwise.

getName

public String getName(Command command)

Returns name of specified command. Returns null if specified command has not been registered or if specified command has been lazily registered and getCommand(java.lang.String) has not yet been used for it.

getLabel

public String getLabel(Command command)

Returns a label (guaranteed to be non-null) for specified command. This label is useful to represent the command in a GUI.

See Also:

getName(com.xmlmind.xmledit.control.Command)

getAllNames

public String[] getAllNames()

Returns a sorted array containing the names of all the registered commands having a null namespace.

This command is equivalent to getAllLocalNames(null).

getAllLocalNames

public String[] getAllLocalNames(String namespace)

Returns a sorted array containing the local names of all the registered commands having specified namespace.

Parameters:

namespace - the namespace of the commands. May be null.

See Also:

getAllNames()

getAllCommands

public Command[] getAllCommands(String namespace)

Returns a array containing all the registered commands having specified namespace. The elements of this array are sorted by the names of the commands.

Parameters:

namespace - the namespace of the commands. May be null.

getDescriptions

public String[][] getDescriptions(Binding[] bindings)

Returns descriptions for specified bindings. The returned list is sorted: sorted mouse bindings, followed by sorted keyboard bindings, followed by sorted application event bindings.

See Also:

getDescription(com.xmlmind.xmledit.control.Binding)

getDescription

public String[] getDescription(Binding binding)

Returns a 3-field description of specified binding.

description[0]

String representation of user input sequence used to trigger a command or to popup a menu.

description[1]

Command name or fixed string "(pop up a menu)".

description[2]

Command parameter if any, or empty string.

setSharedInstance

public static final void setSharedInstance(CommandRegistry registry)

Installs the shared instance of CommandRegistry.

See Also:

getSharedInstance()

getSharedInstance

public static final CommandRegistry getSharedInstance()

Returns the shared instance of CommandRegistry.

Creates and installs one if setSharedInstance(com.xmlmind.xmledit.control.CommandRegistry) has never been invoked or has been set to null.