FieldValueCounterService (Spring XD 1.0.0.M1 API)

All Known Implementing Classes:

InMemoryFieldValueCounterService, RedisFieldValueCounterService
```
public interface FieldValueCounterService
```
A Counter service that allows you to increment and decrement the count by one for a specific field. You can also reset the counter of a specific field. It also provides a 'getOrCreate' method that will return an existing counter given the name or create a new counter set to zero.

Author:

Mark Pollack

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`decrement(java.lang.String name, java.lang.String fieldName)` Decrement the FieldValueCounter for a given field name by one
`FieldValueCounter`	`getOrCreate(java.lang.String name)` Returns an existing FieldValueCounter for the given name or creates a new FieldValueCounter with the counts of all fields set to zero
`void`	`increment(java.lang.String name, java.lang.String fieldName)` Increment the FieldValueCounter for a given field name by one
`void`	`reset(java.lang.String name, java.lang.String fieldName)` Reset the FieldValueCounter to zero for the given field name

- Method Detail
  - getOrCreate
```
FieldValueCounter getOrCreate(java.lang.String name)
```
    Returns an existing FieldValueCounter for the given name or creates a new FieldValueCounter with the counts of all fields set to zero
    
    Parameters:
    name - name of the FieldValueCounter
    
    Returns:
    existing or new FieldValueCounter.
    
    Throws:
    
    java.lang.IllegalArgumentException - in case the given name is null
  - increment
```
void increment(java.lang.String name,
             java.lang.String fieldName)
```
    Increment the FieldValueCounter for a given field name by one
    
    Parameters:
    name - the FieldValueCounter name
    fieldName - the name of the field
    
    Throws:
    
    java.lang.IllegalArgumentException - in case the given name is null
  - decrement
```
void decrement(java.lang.String name,
             java.lang.String fieldName)
```
    Decrement the FieldValueCounter for a given field name by one
    
    Parameters:
    name - the FieldValueCounter name
    fieldName - the name of the field
    
    Throws:
    
    java.lang.IllegalArgumentException - in case the given name is null
  - reset
```
void reset(java.lang.String name,
         java.lang.String fieldName)
```
    Reset the FieldValueCounter to zero for the given field name
    
    Parameters:
    name - the FieldValueCounter name
    fieldName - the name of the field
    
    Throws:
    
    java.lang.IllegalArgumentException - in case the given name is null

Interface FieldValueCounterService

Method Summary

Method Detail

getOrCreate

increment

decrement

reset