Package org.onosproject.net.meter

Class DefaultMeterFeatures.Builder

java.lang.Object

org.onosproject.net.meter.DefaultMeterFeatures.Builder

All Implemented Interfaces:

MeterFeatures.Builder

Enclosing class:

DefaultMeterFeatures

public static final class DefaultMeterFeatures.Builder
extends Object
implements MeterFeatures.Builder

A DefaultMeterFeatures builder.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	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(Set<Band.Type> types)	Assigns the band types for this meter features.
MeterFeatures.Builder	withEndIndex(long endIndex)	Assigns the end index (inclusive) for this meter features.
MeterFeatures.Builder	withFeatures(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	withScope(MeterScope scope)	Assigns the meter scope.
MeterFeatures.Builder	withStartIndex(long startIndex)	Assigns the start index (inclusive) for this meter features.
MeterFeatures.Builder	withUnits(Set<Meter.Unit> units)	Assigns the capabilities for this meter features.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

forDevice

public MeterFeatures.Builder forDevice(DeviceId deviceId)

Description copied from interface: MeterFeatures.Builder

Assigns the target device for this meter features.

Specified by:

forDevice in interface MeterFeatures.Builder

Parameters:

deviceId - a device id

Returns:

this builder

withMaxMeters

public MeterFeatures.Builder withMaxMeters(long maxMeter)

Description copied from interface: MeterFeatures.Builder

Assigns the max meters value for this meter features.

Specified by:

withMaxMeters in interface MeterFeatures.Builder

Parameters:

maxMeter - the maximum meters available

Returns:

this builder

withStartIndex

public MeterFeatures.Builder withStartIndex(long startIndex)

Description copied from interface: MeterFeatures.Builder

Assigns the start index (inclusive) for this meter features.

Specified by:

withStartIndex in interface MeterFeatures.Builder

Parameters:

startIndex - the start index

Returns:

this builder

withEndIndex

public MeterFeatures.Builder withEndIndex(long endIndex)

Description copied from interface: MeterFeatures.Builder

Assigns the end index (inclusive) for this meter features.

Specified by:

withEndIndex in interface MeterFeatures.Builder

Parameters:

endIndex - the end index

Returns:

this builder

withMaxBands

public MeterFeatures.Builder withMaxBands(short maxBands)

Description copied from interface: MeterFeatures.Builder

Assigns the max bands value for this meter features.

Specified by:

withMaxBands in interface MeterFeatures.Builder

Parameters:

maxBands - the maximum bands available.

Returns:

this builder

withMaxColors

public MeterFeatures.Builder withMaxColors(short maxColors)

Description copied from interface: MeterFeatures.Builder

Assigns the max colors value for this meter features.

Specified by:

withMaxColors in interface MeterFeatures.Builder

Parameters:

maxColors - the maximum colors available.

Returns:

this builder

withBandTypes

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

Description copied from interface: MeterFeatures.Builder

Assigns the band types for this meter features.

Specified by:

withBandTypes in interface MeterFeatures.Builder

Parameters:

types - the band types available.

Returns:

this builder

withUnits

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

Description copied from interface: MeterFeatures.Builder

Assigns the capabilities for this meter features.

Specified by:

withUnits in interface MeterFeatures.Builder

Parameters:

units - the units available

Returns:

this

hasBurst

public MeterFeatures.Builder hasBurst(boolean hasBurst)

Description copied from interface: MeterFeatures.Builder

Assigns the burst capabilities.

Specified by:

hasBurst in interface MeterFeatures.Builder

Parameters:

hasBurst - if the burst is supported

Returns:

this builder

hasStats

public MeterFeatures.Builder hasStats(boolean hasStats)

Description copied from interface: MeterFeatures.Builder

Assigns the stats capabilities.

Specified by:

hasStats in interface MeterFeatures.Builder

Parameters:

hasStats - if the statistics are supported

Returns:

this builder

withFeatures

public MeterFeatures.Builder withFeatures(Set<MeterFeaturesFlag> featureFlags)

Description copied from interface: MeterFeatures.Builder

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

Specified by:

withFeatures in interface MeterFeatures.Builder

Parameters:

featureFlags - if meter features flags are supported

Returns:

this builder

withScope

public MeterFeatures.Builder withScope(MeterScope scope)

Description copied from interface: MeterFeatures.Builder

Assigns the meter scope.

Specified by:

withScope in interface MeterFeatures.Builder

Parameters:

scope - the scope

Returns:

this builder

build

public MeterFeatures build()

Description copied from interface: MeterFeatures.Builder

Builds the Meter Features based on the specified parameters.

Specified by:

build in interface MeterFeatures.Builder

Returns:

the meter features