org.springframework.xd.shell.command

Class FieldValueCounterCommands

java.lang.Object

org.springframework.xd.shell.command.AbstractMetricsCommands

org.springframework.xd.shell.command.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:

Ilayaperumal Gopinathan

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FieldValueCounterCommands()

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, int size)
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

FieldValueCounterCommands

protected FieldValueCounterCommands()

Method Detail

available

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

display

@CliCommand(value="field-value-counter display",
            help="Display the value of a field-value-counter")
public Table display(@CliOption(key={"","name"},help="the name of the field-value-counter to display",mandatory=true,optionContext="existing-fvc disable-string-converter")
                       java.lang.String name,
                       @CliOption(key="pattern",help="the pattern used to format the field-value-counter\'s field count (see DecimalFormat)",mandatory=false,unspecifiedDefaultValue="")
                       java.text.NumberFormat pattern,
                       @CliOption(key="size",help="the number of values to display",mandatory=false,unspecifiedDefaultValue="25")
                       int size)

list

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

delete

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