org.springframework.xd.shell.command

Class RichGaugeCommands

java.lang.Object

org.springframework.xd.shell.command.AbstractMetricsCommands

org.springframework.xd.shell.command.RichGaugeCommands

All Implemented Interfaces:

org.springframework.shell.core.CommandMarker

@Component
public class RichGaugeCommands
extends AbstractMetricsCommands
implements org.springframework.shell.core.CommandMarker

Commands for interacting with RichGauge analytics.

Author:

Ilayaperumal Gopinathan

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RichGaugeCommands()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	available()
java.lang.String	delete(java.lang.String name)
Table	display(java.lang.String name, java.text.NumberFormat pattern)
Table	list()

Methods inherited from class org.springframework.xd.shell.command.AbstractMetricsCommands

displayMetrics

Methods inherited from class java.lang.Object

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

Constructor Detail

RichGaugeCommands

protected RichGaugeCommands()

Method Detail

available

@CliAvailabilityIndicator(value={"rich-gauge list","rich-gauge delete","rich-gauge display"})
public boolean available()

list

@CliCommand(value="rich-gauge list",
            help="List all available richgauge names")
public Table list()

display

@CliCommand(value="rich-gauge display",
            help="Display Rich Gauge value")
public Table display(@CliOption(key={"","name"},help="the name of the richgauge to display value",mandatory=true,optionContext="existing-rich-gauge disable-string-converter")
                       java.lang.String name,
                       @CliOption(key="pattern",help="the pattern used to format the richgauge value (see DecimalFormat)",mandatory=false,unspecifiedDefaultValue="")
                       java.text.NumberFormat pattern)

delete

@CliCommand(value="rich-gauge delete",
            help="Delete the richgauge")
public java.lang.String delete(@CliOption(key={"","name"},help="the name of the richgauge to delete",mandatory=true,optionContext="existing-rich-gauge disable-string-converter")
                                 java.lang.String name)