Skip navigation links

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

java.lang.Object
com.essbase.eas.framework.defs.command.CommandArgument

public final class CommandArgument

extends java.lang.Object

Describes command arguments that are used by the framework when parsing client commands and routing them to the correct command listener. This class cannot be extended and instances of this class cannot be modified after they are constructed. Warning: This is strictly not true since the object that the default value references can be modified outside the scope of the CommandArgument object.

Since:

6.5.3

Version:

7.1.0

Author:

Hank Cox

Field Summary

static CommandArgument[]

EMPTY

Constructor Summary

CommandArgument(java.lang.String name, boolean required, java.lang.Class ctype, java.lang.Object value)
Constructs a CommandArgument object with the requested values.

CommandArgument(java.lang.String name, boolean required, java.lang.Class ctype, java.lang.Object value, boolean hidden)
constructs a CommandArgument object with the requested values.

Method Summary

java.lang.Class	getClassType() Gets the class type expected as the value for this argument.
java.lang.Object	getDefaultValue() Gets the default value that can be used for this argument.
java.lang.String	getName() Gets the name of this argument.
boolean	isHidden() Gets the flag indicating whether this is a "hidden" value argument.
boolean	isRequired() Gets the flag indicating whether this argument is required or optional.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static CommandArgument[] EMPTY

Constructor Detail

CommandArgument

public CommandArgument(java.lang.String name,
                       boolean required,
                       java.lang.Class ctype,
                       java.lang.Object value)

Constructs a CommandArgument object with the requested values.

Parameters:

name - Specifies the name of the argument. This is the parameter name that will be placed in the http request that is sent to the EAS server.

required - Indicates whether this argument is required or optional. A true value means the argument is required and a false value the argument is optional.

ctype - Specifies the class type of the object expected for this argument.

value - Specifies a default object to use if the argument is missing from the command.

CommandArgument

public CommandArgument(java.lang.String name,
                       boolean required,
                       java.lang.Class ctype,
                       java.lang.Object value,
                       boolean hidden)

constructs a CommandArgument object with the requested values.

Parameters:

name - Specifies the name of the argument. This is the parameter name that will be placed in the http request that is sent to the EAS server.

required - Indicates whether this argument is required or optional. A true value means the argument is required and a false value the argument is optional.

ctype - Specifies the class type of the object expected for this argument.

value - Specifies a default object to use if the argument is missing from the command.

hidden - Indicates whether the value of this argument should be hidden from display; i.e., passwords, other sensitive info. This is useful when the EAS server's logging facility is enabled and is set to a level that log's all commands received by the server.

Method Detail

getName

public java.lang.String getName()

Gets the name of this argument. For ths most part, this method will only be used by the EAS framework during command parsing.

Returns:

the name of this argument

getClassType

public java.lang.Class getClassType()

Gets the class type expected as the value for this argument. For the most part, this method will only be used by the EAS framework during command parsing.

Returns:

the Class object representing the type of object expected as the value for this command argument.

getDefaultValue

public java.lang.Object getDefaultValue()

Gets the default value that can be used for this argument. For the most part, this method will only be used by the EAS framework during command parsing.

Returns:

the Object representing the default value for this argument

isRequired

public boolean isRequired()

Gets the flag indicating whether this argument is required or optional. For the most part, this method will only be used by the EAS framework during command parsing.

Returns:

a true if this argument is required, false otherwise.

isHidden

public boolean isHidden()

Gets the flag indicating whether this is a "hidden" value argument. Tracing information will be displayed as "******" if this is true. For the most part, this method will only be called by the EAS framework during command parsing.

Returns:

a true if this is a hidden value argument.

Skip navigation links