Package org.mycore.frontend.cli

Class MCRAbstractCommands

java.lang.Object

org.mycore.frontend.cli.MCRAbstractCommands

All Implemented Interfaces:

MCRExternalCommandInterface

Direct Known Subclasses:

MCRAccessCommands, MCRAccessCtrlCommands, MCRBatchEditorCommands, MCRClassification2Commands, MCRCryptCommands, MCRDerivateCommands, MCRGoogleSitemapCommands, MCRIView2Commands, MCRLoggingCommands, MCRMetsCommands, MCRMODSCommands, MCRObjectCommands, MCRSolrCommands, MCRUserCommands

public abstract class MCRAbstractCommands
extends Object
implements MCRExternalCommandInterface

This class is an abstract for the implementation of command classes for the MyCoRe commandline system.

Version:

$Revision$ $Date: 2009-07-28 11:32:04 +0200 (Tue, 28 Jul 2009) $

Author:

Jens Kupferschmidt

Field Summary

Fields

Modifier and Type	Field	Description
protected ArrayList<MCRCommand>	command	The array holding all known commands

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MCRAbstractCommands()	The constructor.
protected	MCRAbstractCommands(String displayName)

Method Summary

Modifier and Type	Method	Description
void	addCommand(MCRCommand cmd)
String	getDisplayName()	Returns the display name of the external commands.
ArrayList<MCRCommand>	getPossibleCommands()	The method return the list of possible commands of this class.
void	setDisplayName(String s)	Sets the display name.

Methods inherited from class java.lang.Object

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

Field Details

command

protected ArrayList<MCRCommand> command

The array holding all known commands

Constructor Details

MCRAbstractCommands

protected MCRAbstractCommands()

The constructor.

MCRAbstractCommands

protected MCRAbstractCommands(String displayName)

Parameters:

displayName - a human readable name for this collection of commands

Method Details

getPossibleCommands

public ArrayList<MCRCommand> getPossibleCommands()

The method return the list of possible commands of this class. Each command has TWO Strings, a String of the user command syntax and a String of the called method.

Specified by:

getPossibleCommands in interface MCRExternalCommandInterface

Returns:

a ascending sorted command pair ArrayList

getDisplayName

public String getDisplayName()

Description copied from interface: MCRExternalCommandInterface

Returns the display name of the external commands. If the display name has not been set the simple class name is returned

Specified by:

getDisplayName in interface MCRExternalCommandInterface

Returns:

the display name of the external commands

setDisplayName

public void setDisplayName(String s)

Description copied from interface: MCRExternalCommandInterface

Sets the display name.

Specified by:

setDisplayName in interface MCRExternalCommandInterface

addCommand

public void addCommand(MCRCommand cmd)