AtomicCounterMapBuilder (onos-api)

public interface AtomicCounterMapBuilder<K>

Builder for AtomicCounterMap.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AtomicCounterMap<K>`	`build()` Builds a AtomicCounterMap based on the configuration options supplied to this builder.
`AsyncAtomicCounterMap<K>`	`buildAsyncAtomicCounterMap()` Builds a AsyncAtomicCounterMap based on the configuration options supplied to this builder.
`AtomicCounterMapBuilder<K>`	`withMeteringDisabled()` Instantiates Metering service to gather usage and performance metrics.
`AtomicCounterMapBuilder<K>`	`withName(String name)` Sets the name for the atomic counter map.
`AtomicCounterMapBuilder<K>`	`withPartitionsDisabled()` Creates this counter map on the partition that spans the entire cluster.

- Method Detail
  - withName
```
AtomicCounterMapBuilder<K> withName(String name)
```
    Sets the name for the atomic counter map.
    Each atomic counter map is identified by a unique name.
    
    Note: This is a mandatory parameter.
    
    Parameters:
    
    name - name of the atomic counter
    
    Returns:
    
    this AtomicCounterMapBuilder
  - withPartitionsDisabled
```
AtomicCounterMapBuilder<K> withPartitionsDisabled()
```
    Creates this counter map on the partition that spans the entire cluster.
    When partitioning is disabled, the counter state will be ephemeral and does not survive a full cluster restart.
    
    Note: By default partitions are enabled.
    
    Returns:
    
    this AtomicCounterMapBuilder
  - withMeteringDisabled
```
AtomicCounterMapBuilder<K> withMeteringDisabled()
```
    Instantiates Metering service to gather usage and performance metrics. By default, usage data will be stored.
    
    Returns:
    
    this AtomicCounterMapBuilder
  - build
```
AtomicCounterMap<K> build()
```
    Builds a AtomicCounterMap based on the configuration options supplied to this builder.
    
    Returns:
    
    new AtomicCounterMap
    
    Throws:
    
    RuntimeException - if a mandatory parameter is missing
  - buildAsyncAtomicCounterMap
```
AsyncAtomicCounterMap<K> buildAsyncAtomicCounterMap()
```
    Builds a AsyncAtomicCounterMap based on the configuration options supplied to this builder.
    
    Returns:
    
    new AsyncAtomicCounterMap
    
    Throws:
    
    RuntimeException - if a mandatory parameter is missing

Interface AtomicCounterMapBuilder<K>

Method Summary

Method Detail

withName

withPartitionsDisabled

withMeteringDisabled

build

buildAsyncAtomicCounterMap