org.springframework.xd.shell.command

Class GaugeCommands

java.lang.Object

org.springframework.xd.shell.command.AbstractMetricsCommands

org.springframework.xd.shell.command.GaugeCommands

All Implemented Interfaces:

org.springframework.shell.core.CommandMarker

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

Commands for interacting with Gauge analytics.

Author:

Ilayaperumal Gopinathan

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GaugeCommands()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	available()
java.lang.String	delete(java.lang.String name)
java.lang.String	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

GaugeCommands

protected GaugeCommands()

Method Detail

available

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

list

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

display

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

delete

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