org.glassfish.api.admin

Class CommandModel.ParamModel

java.lang.Object

org.glassfish.api.admin.CommandModel.ParamModel

Direct Known Subclasses:

CommandModelData.ParamModelData

Enclosing class:

CommandModel

public abstract static class CommandModel.ParamModel
extends Object

Model for a command parameter.

Constructor Summary

Constructors

Constructor and Description
ParamModel()

Method Summary

Modifier and Type	Method and Description
abstract String	getLocalizedDescription() Returns a localized description for this parameter
abstract String	getLocalizedPrompt() Returns a localized prompt for this parameter
abstract String	getLocalizedPromptAgain() Returns a localized confirmation prompt for this parameter.
abstract String	getName() Returns the command parameter name.
abstract Param	getParam() Returns the command @Param annotation values.
abstract Class	getType() Returns the parameter type.
boolean	isParamId(String key)

Methods inherited from class java.lang.Object

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

Constructor Detail

ParamModel

public ParamModel()

Method Detail

getName

public abstract String getName()

Returns the command parameter name.

Returns:

the command parameter name

getParam

public abstract Param getParam()

Returns the command @Param annotation values.

Returns:

the @Param instance for this parameter

getLocalizedDescription

public abstract String getLocalizedDescription()

Returns a localized description for this parameter

Returns:

a localized String

getLocalizedPrompt

public abstract String getLocalizedPrompt()

Returns a localized prompt for this parameter

Returns:

a localized String

getLocalizedPromptAgain

public abstract String getLocalizedPromptAgain()

Returns a localized confirmation prompt for this parameter. This is only used for passwords.

Returns:

a localized String

getType

public abstract Class getType()

Returns the parameter type.

Returns:

the parameter type.

isParamId

public boolean isParamId(String key)