Package org.onosproject.net.meter

Class DefaultMeterFeatures

java.lang.Object

org.onosproject.net.meter.DefaultMeterFeatures

All Implemented Interfaces:

MeterFeatures

public final class DefaultMeterFeatures
extends Object
implements MeterFeatures

Default implementation of MeterFeatures.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultMeterFeatures.Builder	A DefaultMeterFeatures builder.

Method Summary

Modifier and Type	Method	Description
Set<Band.Type>	bandTypes()	Returns band types supported.
static DefaultMeterFeatures.Builder	builder()
DeviceId	deviceId()	Return the device id to which this meter features apply.
long	endIndex()	Returns the end index (inclusive) of the meters.
Set<MeterFeaturesFlag>	features()	Returns features flags that supported for meter actions by device.
boolean	isBurstSupported()	Returns if burst size is available.
boolean	isStatsSupported()	Returns if statistics collection is available.
short	maxBands()	Returns the maximum bands per meter.
short	maxColor()	Returns the maximum colors value for DiffServ operation.
long	maxMeter()	Returns the maximum number of meters accepted by the device.
static MeterFeatures	noMeterFeatures(DeviceId deviceId)
MeterScope	scope()	Returns Meter Scope.
long	startIndex()	Returns the start index (inclusive) of the meters.
String	toString()
Set<Meter.Unit>	unitTypes()	Returns unit types available for meters.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

deviceId

public DeviceId deviceId()

Description copied from interface: MeterFeatures

Return the device id to which this meter features apply.

Specified by:

deviceId in interface MeterFeatures

Returns:

the device id

maxMeter

public long maxMeter()

Description copied from interface: MeterFeatures

Returns the maximum number of meters accepted by the device.

Specified by:

maxMeter in interface MeterFeatures

Returns:

the maximum meter value.

startIndex

public long startIndex()

Description copied from interface: MeterFeatures

Returns the start index (inclusive) of the meters.

Specified by:

startIndex in interface MeterFeatures

Returns:

the start index

endIndex

public long endIndex()

Description copied from interface: MeterFeatures

Returns the end index (inclusive) of the meters.

Specified by:

endIndex in interface MeterFeatures

Returns:

the end index

bandTypes

public Set<Band.Type> bandTypes()

Description copied from interface: MeterFeatures

Returns band types supported.

Specified by:

bandTypes in interface MeterFeatures

Returns:

the band types supported.

unitTypes

public Set<Meter.Unit> unitTypes()

Description copied from interface: MeterFeatures

Returns unit types available for meters.

Specified by:

unitTypes in interface MeterFeatures

Returns:

the unit types available.

isBurstSupported

public boolean isBurstSupported()

Description copied from interface: MeterFeatures

Returns if burst size is available.

Specified by:

isBurstSupported in interface MeterFeatures

Returns:

burst availability

isStatsSupported

public boolean isStatsSupported()

Description copied from interface: MeterFeatures

Returns if statistics collection is available.

Specified by:

isStatsSupported in interface MeterFeatures

Returns:

statistics availability

maxBands

public short maxBands()

Description copied from interface: MeterFeatures

Returns the maximum bands per meter.

Specified by:

maxBands in interface MeterFeatures

Returns:

the max bands value

maxColor

public short maxColor()

Description copied from interface: MeterFeatures

Returns the maximum colors value for DiffServ operation.

Specified by:

maxColor in interface MeterFeatures

Returns:

the maximum colors value.

features

public Set<MeterFeaturesFlag> features()

Description copied from interface: MeterFeatures

Returns features flags that supported for meter actions by device.

Specified by:

features in interface MeterFeatures

Returns:

meter features flags otherwise empty set.

scope

public MeterScope scope()

Description copied from interface: MeterFeatures

Returns Meter Scope.

Specified by:

scope in interface MeterFeatures

Returns:

meter scope

builder

public static DefaultMeterFeatures.Builder builder()

noMeterFeatures

public static MeterFeatures noMeterFeatures(DeviceId deviceId)

toString

public String toString()

Overrides:

toString in class Object