com.kabira.platform.management

Annotation Type Parameter

@Documented
@Inherited
@Retention(value=RUNTIME)
@Target(value=PARAMETER)
public @interface Parameter

ManagementTarget Command parameter. Must be present on all parameters of a method annotated as a @Command. Valid parameter types are String, Enum, Boolean, Character, Integer, Byte, Short, Long, Float, and Double. Other types will cause TargetException to be thrown when the target is registered. Arrays are not supported. see java.lang.String for descriptions of valid String formats for the supported parameter types.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	name The parameter name as exposed to management clients

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Default	defaultValue The default value of the parameter.
java.lang.String	description A description of the parameter.
boolean	required Indicates that this parameter must be set by the caller.

Element Detail

name

public abstract java.lang.String name

The parameter name as exposed to management clients

description

public abstract java.lang.String description

A description of the parameter. Used in the generated help for the command.

Default:

""

required

public abstract boolean required

Indicates that this parameter must be set by the caller. If the parameter is not set. the command will fail. If false, and no default is provided, the value of the parameter will be null

Default:

false

defaultValue

public abstract Default defaultValue

The default value of the parameter.

Default:

@com.kabira.platform.management.Default(provided=false, value="")