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

Class FieldValueCounterCommands

java.lang.Object

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

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

All Implemented Interfaces:

org.springframework.shell.core.CommandMarker

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

Commands for interacting with Field Value Counter analytics.

Author:

Eric Bottard, Ilayaperumal Gopinathan, Gunnar Hillert

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FieldValueCounterCommands()

Method Summary

Modifier and Type	Method and Description
boolean	availableWithCreateRole()
boolean	availableWithViewRole()
List<Object>	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

RESET_COUNTER

public static final String RESET_COUNTER

See Also:

Constant Field Values

Constructor Detail

FieldValueCounterCommands

protected FieldValueCounterCommands()

Method Detail

availableWithViewRole

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

availableWithCreateRole

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

display

@CliCommand(value="field-value-counter display",
            help="Display the value of a field value counter")
public List<Object> display(@CliOption(key={"","name"},help="the name of the field value counter to display",mandatory=true,optionContext="existing-field-value-counter disable-string-converter")
                                                                                                                                            String name,
                                                                                                                                            @CliOption(key="pattern",help="the pattern used to format the values (see DecimalFormat)",mandatory=false,unspecifiedDefaultValue="<use platform locale>")
                                                                                                                                            NumberFormat pattern)

list

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

reset

@CliCommand(value="field-value-counter reset",
            help="Reset the field value counter with the given name")
public String reset(@CliOption(mandatory=true,key={"","name"},help="the name of the field value counter to reset",optionContext="existing-field-value-counter disable-string-converter")
                                                                                                                                         String name)