org.springframework.cloud.dataflow.shell.command

Class CounterCommands

java.lang.Object

org.springframework.cloud.dataflow.shell.command.AbstractMetricsCommands

org.springframework.cloud.dataflow.shell.command.CounterCommands

All Implemented Interfaces:

org.springframework.shell.core.CommandMarker

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

Commands for interacting with Counter analytics.

Author:

Eric Bottard, Ilayaperumal Gopinathan

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CounterCommands()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	available()
String	display(String name, NumberFormat pattern)
org.springframework.shell.table.Table	list()
String	reset(String name)

Methods inherited from class org.springframework.cloud.dataflow.shell.command.AbstractMetricsCommands

displayMetrics

Methods inherited from class java.lang.Object

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

Constructor Detail

CounterCommands

protected CounterCommands()

Method Detail

available

@CliAvailabilityIndicator(value={"counter list","counter display","counter reset"})
public boolean available()

display

@CliCommand(value="counter display",
            help="Display the value of a counter")
public String display(@CliOption(key={"","name"},help="the name of the counter to display",mandatory=true)
                        String name,
                        @CliOption(key="pattern",help="the pattern used to format the value (see DecimalFormat)",mandatory=false,unspecifiedDefaultValue="")
                        NumberFormat pattern)

list

@CliCommand(value="counter list",
            help="List all available counter names")
public org.springframework.shell.table.Table list()

reset

@CliCommand(value="counter reset",
            help="Reset the counter with the given name")
public String reset(@CliOption(mandatory=true,key={"","name"},help="the name of the counter to reset")
                      String name)