Skip navigation links


com.essbase.eas.framework.defs.command
Class CommandDescriptor

java.lang.Object
  extended by com.essbase.eas.framework.defs.command.CommandDescriptor


public final class CommandDescriptor
extends java.lang.Object

Describes commands that are implemented by command listeners in the server framework. The framework will query each command listener to retrieve a set of command descriptors. When the framework receives incoming commands it uses the global set of command descriptors to parse arguments, convert arguments to values and objects, and route the command to the correct command listener. A correct CommandDescriptor object consists of the command string, the method in the command listener for handling the command, and a set of 0 or more CommandArgument objects.

Since:
6.5.3
Version:
7.1.0
Author:
Hank Cox

Constructor Summary
CommandDescriptor(CommandString command, java.lang.String method, CommandArgument[] arguments)
          constructs a CommandDescriptor object where the method name and the command name are different and with a set of expected arguments.

 

Method Summary
 CommandArgument[] getArguments()
          Returns the command arguments that this command is expecting.
 CommandString getCommand()
          Gets CommandString object that contains the text corresponding to the name of the command.
 java.lang.String getMethod()
          returns the name of the CommandListener method that will be called when an instance of this command is received by the framework .

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

CommandDescriptor

public CommandDescriptor(CommandString command,
                         java.lang.String method,
                         CommandArgument[] arguments)
constructs a CommandDescriptor object where the method name and the command name are different and with a set of expected arguments.
Parameters:
command - a String-derived object with the name of the command.
method - a String-derived object with the name of the method to call in the CommandListener.
arguments - an array of CommandArgument objects describing the expected set of arguments for this command.

Method Detail

getCommand

public CommandString getCommand()
Gets CommandString object that contains the text corresponding to the name of the command.
Returns:
the name of the command.

getMethod

public java.lang.String getMethod()
returns the name of the CommandListener method that will be called when an instance of this command is received by the framework .
Returns:
returns the String object representing the name of the method

getArguments

public CommandArgument[] getArguments()
Returns the command arguments that this command is expecting. This can be an array of length zero, but will never be null.
Returns:
the array of CommandArgument for this descriptor

Skip navigation links


Copyright © 2001, 2012, Oracle. All rights reserved.