|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.iplanet.jato.command.CommandDescriptor
Provides the minimum set of information needed to support the automatic execution of a specific Command.
Constructor Summary | |
CommandDescriptor()
Default Constructor |
|
CommandDescriptor(java.lang.Class commandClass,
java.lang.String operationName)
Creates a CommandDescriptor object |
|
CommandDescriptor(java.lang.Class commandClass,
java.lang.String operationName,
java.util.Map parameters)
Creates a CommandDescriptor object |
|
CommandDescriptor(Command command,
java.lang.String operationName)
Creates a CommandDescriptor object |
|
CommandDescriptor(Command command,
java.lang.String operationName,
java.util.Map parameters)
Creates a CommandDescriptor object |
Method Summary | |
Command |
getCommand()
Returns the Command instance that should be
executed. |
java.lang.Class |
getCommandClass()
Returns the class of the Command that should be
executed |
protected java.lang.Class |
getDefaultCommandClass()
Returns the default command class. |
java.lang.String |
getOperationName()
Returns the command operation that should be used during execution of the Command |
java.lang.Object |
getParameter(java.lang.Object key)
Convenience method for getting the value of a command parameter |
java.util.Map |
getParameters()
Return the map of command parameters |
void |
setCommand(Command value)
Sets the Command instance that should be
executed. |
void |
setCommandClass(java.lang.Class value)
Sets the class of the Command that should be
executed |
void |
setOperationName(java.lang.String value)
Sets the command operation that should be used during execution of the Command |
void |
setParameter(java.lang.Object key,
java.lang.Object value)
Convenience method for setting the value of a command parameter |
void |
setParameters(java.util.Map value)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public CommandDescriptor()
public CommandDescriptor(java.lang.Class commandClass, java.lang.String operationName)
CommandDescriptor
objectcommandClass
- The class of the Command
to be executed,
or null
if the default behavior should be
executedoperationName
- The name of the command operation that should be used during
execution of the Command
public CommandDescriptor(Command command, java.lang.String operationName)
CommandDescriptor
objectcommand
- The Command
instance that should be executed.operationName
- The name of the command operation that should be used during
execution of the Command
public CommandDescriptor(java.lang.Class commandClass, java.lang.String operationName, java.util.Map parameters)
CommandDescriptor
objectcommandClass
- The class of the Command
to be executed,
or null
if the default behavior should be
executedoperationName
- The name of the command operation that should be used during
execution of the Command
parameters
- The command paramaters may be an arbitrarily complex collection
of objects which are meaningful to the Command object at
the time of command execution.public CommandDescriptor(Command command, java.lang.String operationName, java.util.Map parameters)
CommandDescriptor
objectcommand
- The Command
instance that should be executed.operationName
- The name of the command operation that should be used during
execution of the Command
parameters
- The command paramaters may be an arbitrarily complex collection
of objects which are meaningful to the Command object at
the time of command execution.Method Detail |
public Command getCommand()
Command
instance that should be
executed. This method may optionally return null
if the caller should create the command from the command class
specified by the getCommandClass()
method. The
main reason this method exists is to allow specification of
command objects that require significant initialization.Command
instance to be executed,
or null
if the caller should create
the command from the command class specified by the
getCommandClass()
method.public void setCommand(Command value)
Command
instance that should be
executed. This method may optionally return null
if the caller should create the command from the command class
specified by the getCommandClass()
method. The
main reason this method exists is to allow specification of
command objects that require significant initialization.value
- The Command
instance to be executed,
or null
if the caller should create
the command from the command class specified by the
getCommandClass()
method.public java.lang.Class getCommandClass()
Command
that should be
executedCommand
to be executed,
or null
if the default behavior should be
executedpublic void setCommandClass(java.lang.Class value)
Command
that should be
executedCommand
to be executed,
or null
if the default behavior should be
executedprotected java.lang.Class getDefaultCommandClass()
getCommandClass()
method is called
but no command class has been specified. This returned
class is null by default; developers should override this
method in subclasses to provide a default command class.public java.lang.String getOperationName()
Command
Command
. This value may be null
if the target Command
allows that
value. The default value of the operation name
is the constant Command.DEFAULT_OPERATION_NAME
.public void setOperationName(java.lang.String value)
Command
value
- A command operation meaningful to the target
Command
. This value may be null
if the target Command
allows that
value. The default value of the operation name
is the constant Command.DEFAULT_OPERATION_NAME
.public java.util.Map getParameters()
public void setParameters(java.util.Map value)
public java.lang.Object getParameter(java.lang.Object key)
public void setParameter(java.lang.Object key, java.lang.Object value)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |