org.cyclopsgroup.jmxterm.cmd

Class GetCommand

java.lang.Object

org.cyclopsgroup.jmxterm.Command

org.cyclopsgroup.jmxterm.cmd.GetCommand

All Implemented Interfaces:

org.cyclopsgroup.jcli.AutoCompletable

@Cli(name="get",
     description="Get value of MBean attribute(s)",
     note="* stands for all attributes. eg. get Attribute1 Attribute2 or get *")
public class GetCommand
extends Command

Get value of MBean attribute(s)

Author:

Jiaqi Guo

Constructor Summary

Constructors

Constructor and Description
GetCommand()

Method Summary

Modifier and Type	Method and Description
List<String>	doSuggestArgument() Provide a list of possible arguments for auto completion.
protected List<String>	doSuggestOption(String optionName) Provide a list of possible option values for auto completion
void	execute() Execute command
void	setAttributes(List<String> attributes)
void	setBean(String bean)
void	setDelimiter(String delimiter)
void	setDomain(String domain)
void	setShowDescription(boolean showDescription)
void	setShowQuotationMarks(boolean noQuotationMarks)
void	setSimpleFormat(boolean simpleFormat)
void	setSingleLine(boolean singleLine)

Methods inherited from class org.cyclopsgroup.jmxterm.Command

getSession, isHelp, setHelp, setSession, suggestArgument, suggestOption

Methods inherited from class java.lang.Object

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

Constructor Detail

GetCommand

public GetCommand()

Method Detail

doSuggestArgument

public List<String> doSuggestArgument()
                               throws IOException,
                                      JMException

Description copied from class: Command

Provide a list of possible arguments for auto completion. This method returns list of arguments(not option) and is called when user presses tab key.

Overrides:

doSuggestArgument in class Command

Returns:

List of possible arguments used by auto completion or NULL

Throws:

IOException - IO errors

JMException - JMX problemo

doSuggestOption

protected List<String> doSuggestOption(String optionName)
                                throws JMException

Description copied from class: Command

Provide a list of possible option values for auto completion

Overrides:

doSuggestOption in class Command

Parameters:

optionName - Name of option

Returns:

List of possible arguments used by auto completion or NULL

Throws:

JMException - JMX errors

execute

public void execute()
             throws JMException,
                    IOException

Description copied from class: Command

Execute command

Specified by:

execute in class Command

Throws:

JMException - JMX errors

IOException - IO errors

setAttributes

@MultiValue(listType=java.util.ArrayList.class,
            minValues=1)
 @Argument(displayName="attr",
          description="Name of attributes to select")
public final void setAttributes(List<String> attributes)

Parameters:

attributes - List of attribute names

setBean

@Option(name="b",
        longName="bean",
        description="MBean name where the attribute is. Optional if bean has been set")
public final void setBean(String bean)

Parameters:

bean - Bean under which attribute is get

setDomain

@Option(name="d",
        longName="domain",
        description="Domain of bean, optional")
public final void setDomain(String domain)

Parameters:

domain - Domain under which bean is selected

setShowDescription

@Option(name="i",
        longName="info",
        description="Show detail information of each attribute")
public final void setShowDescription(boolean showDescription)

Parameters:

showDescription - True to show detail description

setShowQuotationMarks

@Option(name="q",
        longName="quots",
        description="Quotation marks around value")
public final void setShowQuotationMarks(boolean noQuotationMarks)

Parameters:

noQuotationMarks - True if value is not surrounded by quotation marsk

setSimpleFormat

@Option(name="s",
        longName="simple",
        description="Print simple expression of value without full expression")
public final void setSimpleFormat(boolean simpleFormat)

Parameters:

simpleFormat - True if value is printed out in a simple format without full expression

setDelimiter

@Option(name="l",
        longName="delimiter",
        description="Sets an optional delimiter to be printed after the value")
public final void setDelimiter(String delimiter)

setSingleLine

@Option(name="n",
        longName="singleLine",
        description="Prints result without a newline - default is false")
public final void setSingleLine(boolean singleLine)