org.glassfish.common.util.admin
Class GenericCommandModel

java.lang.Object
  org.glassfish.api.admin.CommandModel
      org.glassfish.common.util.admin.GenericCommandModel

public class GenericCommandModel
extends CommandModel

Nested Class Summary

Nested classes/interfaces inherited from class org.glassfish.api.admin.CommandModel

CommandModel.ParamModel

Constructor Summary

GenericCommandModel(java.lang.Class<?> targetType, boolean useAnnotations, ExecuteOn cluster, I18n i18n, LocalStringManager localStrings, org.jvnet.hk2.config.DomDocument document, java.lang.String commandName, java.lang.Class<?>... extraTypes)
GenericCommandModel constructor.

Method Summary

ExecuteOn	getClusteringAttributes()
java.lang.Class<?>	getCommandClass()
java.lang.String	getCommandName()
java.lang.String	getLocalizedDescription()
CommandModel.ParamModel	getModelFor(java.lang.String paramName)
java.util.Collection<java.lang.String>	getParametersNames()
java.lang.String	getUsageText()

Methods inherited from class org.glassfish.api.admin.CommandModel

getParameters, getParamName, unknownOptionsAreOperands

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericCommandModel

public GenericCommandModel(java.lang.Class<?> targetType,
                           boolean useAnnotations,
                           ExecuteOn cluster,
                           I18n i18n,
                           LocalStringManager localStrings,
                           org.jvnet.hk2.config.DomDocument document,
                           java.lang.String commandName,
                           java.lang.Class<?>... extraTypes)

GenericCommandModel constructor.

Parameters:

targetType - the ConfigBeanProxy class that may have additional @Param annotations for the command,

useAnnotations - if true, use the annotations on the targetType class to define the parameters

cluster - the @ExecuteOn annotation, if any

i18n - the @I18n annotation, if any

localStrings - where to find strings for the command

document - the DomDocument for the command

commandName - the name of the command

extraTypes - any extra types that might also define parameters for the command

Method Detail

getLocalizedDescription

public java.lang.String getLocalizedDescription()

Specified by:

getLocalizedDescription in class CommandModel

getUsageText

public java.lang.String getUsageText()

Specified by:

getUsageText in class CommandModel

getCommandName

public java.lang.String getCommandName()

Specified by:

getCommandName in class CommandModel

getModelFor

public CommandModel.ParamModel getModelFor(java.lang.String paramName)

Specified by:

getModelFor in class CommandModel

getParametersNames

public java.util.Collection<java.lang.String> getParametersNames()

Specified by:

getParametersNames in class CommandModel

getCommandClass

public java.lang.Class<?> getCommandClass()

Specified by:

getCommandClass in class CommandModel

getClusteringAttributes

public ExecuteOn getClusteringAttributes()

Specified by:

getClusteringAttributes in class CommandModel