org.onosproject.net.meter

Interface MeterFeatures.Builder

All Known Implementing Classes:

DefaultMeterFeatures.Builder

Enclosing interface:

MeterFeatures

public static interface MeterFeatures.Builder

A meter features builder.

Method Summary

Modifier and Type	Method and Description
MeterFeatures	build() Builds the Meter Features based on the specified parameters.
MeterFeatures.Builder	forDevice(DeviceId deviceId) Assigns the target device for this meter features.
MeterFeatures.Builder	hasBurst(boolean hasBurst) Assigns the burst capabilities.
MeterFeatures.Builder	hasStats(boolean hasStats) Assigns the stats capabilities.
MeterFeatures.Builder	withBandTypes(java.util.Set<Band.Type> types) Assigns the band types for this meter features.
MeterFeatures.Builder	withFeatures(java.util.Set<MeterFeaturesFlag> featureFlags) Assigns the features for this meter features for OF1.5.
MeterFeatures.Builder	withMaxBands(short maxBands) Assigns the max bands value for this meter features.
MeterFeatures.Builder	withMaxColors(short maxColors) Assigns the max colors value for this meter features.
MeterFeatures.Builder	withMaxMeters(long maxMeter) Assigns the max meters value for this meter features.
MeterFeatures.Builder	withUnits(java.util.Set<Meter.Unit> units) Assigns the capabilities for this meter features.

Method Detail

forDevice

MeterFeatures.Builder forDevice(DeviceId deviceId)

Assigns the target device for this meter features.

Parameters:

deviceId - a device id

Returns:

this builder

withMaxMeters

MeterFeatures.Builder withMaxMeters(long maxMeter)

Assigns the max meters value for this meter features.

Parameters:

maxMeter - the maximum meters available

Returns:

this builder

withMaxBands

MeterFeatures.Builder withMaxBands(short maxBands)

Assigns the max bands value for this meter features.

Parameters:

maxBands - the maximum bands available.

Returns:

this builder

withMaxColors

MeterFeatures.Builder withMaxColors(short maxColors)

Assigns the max colors value for this meter features.

Parameters:

maxColors - the maximum colors available.

Returns:

this builder

withBandTypes

MeterFeatures.Builder withBandTypes(java.util.Set<Band.Type> types)

Assigns the band types for this meter features.

Parameters:

types - the band types available.

Returns:

this builder

withUnits

MeterFeatures.Builder withUnits(java.util.Set<Meter.Unit> units)

Assigns the capabilities for this meter features.

Parameters:

units - the units available

Returns:

this

hasBurst

MeterFeatures.Builder hasBurst(boolean hasBurst)

Assigns the burst capabilities.

Parameters:

hasBurst - if the burst is supported

Returns:

this builder

hasStats

MeterFeatures.Builder hasStats(boolean hasStats)

Assigns the stats capabilities.

Parameters:

hasStats - if the statistics are supported

Returns:

this builder

withFeatures

MeterFeatures.Builder withFeatures(java.util.Set<MeterFeaturesFlag> featureFlags)

Assigns the features for this meter features for OF1.5.

Parameters:

featureFlags - if meter features flags are supported

Returns:

this builder

build

MeterFeatures build()

Builds the Meter Features based on the specified parameters.

Returns:

the meter features