org.springframework.cloud.dataflow.shell.command.common

Class CounterCommands

java.lang.Object

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

org.springframework.cloud.dataflow.shell.command.common.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, Gunnar Hillert

Field Summary

Fields

Modifier and Type	Field and Description
static String	DELETE_COUNTER
static String	DISPLAY_COUNTER
static String	LIST_COUNTERS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CounterCommands()

Method Summary

Modifier and Type	Method and Description
boolean	availableWithCreateRole()
boolean	availableWithViewRole()
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.common.AbstractMetricsCommands

displayMetrics

Methods inherited from class java.lang.Object

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

Field Detail

DISPLAY_COUNTER

public static final String DISPLAY_COUNTER

See Also:

Constant Field Values

LIST_COUNTERS

public static final String LIST_COUNTERS

See Also:

Constant Field Values

DELETE_COUNTER

public static final String DELETE_COUNTER

See Also:

Constant Field Values

Constructor Detail

CounterCommands

protected CounterCommands()

Method Detail

availableWithViewRole

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

availableWithCreateRole

@CliAvailabilityIndicator(value="counter reset")
public boolean availableWithCreateRole()

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,optionContext="existing-counter disable-string-converter")
                                                                                                              String name,
                                                                                                              @CliOption(key="pattern",help="the pattern used to format the value (see DecimalFormat)",unspecifiedDefaultValue="<use platform locale>")
                                                                                                              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",optionContext="existing-counter disable-string-converter")
                                                                                                                 String name)