MeterKey (ONOS Java API (2.5.6))

java.lang.Object
- org.onosproject.net.meter.MeterKey

public final class MeterKey
extends Object

A meter key represents a meter uniquely.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`DeviceId`	`deviceId()`
`boolean`	`equals(Object o)`
`int`	`hashCode()`
`static MeterKey`	`key(DeviceId deviceId, MeterCellId id)`
`static MeterKey`	`key(DeviceId deviceId, MeterId id)`	Deprecated. in onos-2.5 replaced by `key(DeviceId,MeterCellId)` extends MeterKey to support both MeterId and PiMeterCellId
`MeterCellId`	`meterCellId()`
`MeterId`	`meterId()`	Deprecated. in onos-2.5 replaced by `key(DeviceId,MeterCellId)` extends MeterKey to support both MeterId and PiMeterCellId
`String`	`toString()`

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

- Method Detail
  - deviceId
```
public DeviceId deviceId()
```
  - meterId
```
@Deprecated
public MeterId meterId()
```
    Deprecated.
    in onos-2.5 replaced by key(DeviceId,MeterCellId) extends MeterKey to support both MeterId and PiMeterCellId
    
    Returns:
    
    a MeterId iff the id is a MeterId otherwise, return null
  - meterCellId
```
public MeterCellId meterCellId()
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - key
```
@Deprecated
public static MeterKey key(DeviceId deviceId,
                           MeterId id)
```
    Deprecated.
    in onos-2.5 replaced by key(DeviceId,MeterCellId) extends MeterKey to support both MeterId and PiMeterCellId
    
    Parameters:
    
    deviceId - a DeviceId
    
    id - a MeterId
    
    Returns:
    
    a MeterKey contains DeviceId and MeterId
  - key
```
public static MeterKey key(DeviceId deviceId,
                           MeterCellId id)
```