MeterId (ONOS Java API (2.5.4))

java.lang.Object
- org.onlab.util.Identifier<Long>
- - org.onosproject.net.meter.MeterId

All Implemented Interfaces:

MeterCellId
```
public final class MeterId
extends Identifier<Long>
implements MeterCellId
```
A representation of a meter cell identifier. Uniquely identifies a meter cell in the scope of a single device.
This ID uniquely identifies a meter cell within in a switch that maintains only one meter instance. If a switch supports multiple meter instances (like in P4), then PiMeterCellId should be used. In this case, meter cells are defined starting with id=1 up to the maximum number of cells that the switch can support. The OpenFlow protocol also defines some additional virtual meter cells that can not be associated with flows.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.onosproject.net.meter.MeterCellId
  MeterCellId.MeterCellType

Field Summary

Fields
Modifier and Type	Field	Description
`static MeterId`	`ALL`	Represents all meters for stat requests commands.
`static MeterId`	`CONTROLLER`	Meter for controller connection.
`static long`	`MAX`	Flow meters can use any number up to MAX.
`static MeterId`	`SLOWPATH`	Meter for slow datapath, if any.

Fields inherited from class org.onlab.util.Identifier
identifier

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static MeterId`	`meterId(long id)`	Creates a new meter identifier.
`String`	`toString()`	Returns a string representation of a DeviceKeyId.
`MeterCellId.MeterCellType`	`type()`	Return the type of this meter cell identifier.

Methods inherited from class org.onlab.util.Identifier
equals, hashCode, id

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - MAX
```
public static final long MAX
```
    Flow meters can use any number up to MAX.
    
    See Also:
    
    Constant Field Values
  - SLOWPATH
```
public static final MeterId SLOWPATH
```
    Meter for slow datapath, if any.
  - CONTROLLER
```
public static final MeterId CONTROLLER
```
    Meter for controller connection.
  - ALL
```
public static final MeterId ALL
```
    Represents all meters for stat requests commands.
- Method Detail
  - toString
```
public String toString()
```
    Description copied from class: Identifier
    
    Returns a string representation of a DeviceKeyId.
    
    Overrides:
    
    toString in class Identifier<Long>
    
    Returns:
    
    string
  - meterId
```
public static MeterId meterId(long id)
```
    Creates a new meter identifier.
    
    Parameters:
    
    id - the backing identifier value
    
    Returns:
    
    meter identifier
  - type
```
public MeterCellId.MeterCellType type()
```
    Description copied from interface: MeterCellId
    
    Return the type of this meter cell identifier.
    
    Specified by:
    
    type in interface MeterCellId
    
    Returns:
    
    type