Package org.onosproject.net.meter

Class DefaultMeter.Builder

java.lang.Object

org.onosproject.net.meter.DefaultMeter.Builder

All Implemented Interfaces:

Meter.Builder

Enclosing class:

DefaultMeter

public static final class DefaultMeter.Builder
extends Object
implements Meter.Builder

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DefaultMeter	build()	Builds the meter based on the specified parameters.
Meter.Builder	burst()	Sets this meter as applicable to burst traffic only.
Meter.Builder	forDevice(DeviceId deviceId)	Assigns the target device for this meter.
Meter.Builder	fromApp(ApplicationId appId)	Assigns the application that built this meter.
DefaultMeter.Builder	withAnnotations(Annotations anns)	Sets the annotations.
Meter.Builder	withBands(Collection<Band> bands)	Assigns bands to this meter.
Meter.Builder	withCellId(MeterCellId cellId)	Assigns the id to this meter cell.
Meter.Builder	withId(MeterId id)	Assigns the id to this meter.
Meter.Builder	withUnit(Meter.Unit unit)	Assigns the @See Unit to use for this meter.

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 Meter.Builder forDevice(DeviceId deviceId)

Description copied from interface: Meter.Builder

Assigns the target device for this meter.

Specified by:

forDevice in interface Meter.Builder

Parameters:

deviceId - a device id

Returns:

this

withId

public Meter.Builder withId(MeterId id)

Description copied from interface: Meter.Builder

Assigns the id to this meter.

Specified by:

withId in interface Meter.Builder

Parameters:

id - a e

Returns:

this

withCellId

public Meter.Builder withCellId(MeterCellId cellId)

Description copied from interface: Meter.Builder

Assigns the id to this meter cell.

Specified by:

withCellId in interface Meter.Builder

Parameters:

cellId - a meter cell identifier

Returns:

this

fromApp

public Meter.Builder fromApp(ApplicationId appId)

Description copied from interface: Meter.Builder

Assigns the application that built this meter.

Specified by:

fromApp in interface Meter.Builder

Parameters:

appId - an application id

Returns:

this

withUnit

public Meter.Builder withUnit(Meter.Unit unit)

Description copied from interface: Meter.Builder

Assigns the @See Unit to use for this meter. Defaults to kb/s

Specified by:

withUnit in interface Meter.Builder

Parameters:

unit - a unit

Returns:

this

burst

public Meter.Builder burst()

Description copied from interface: Meter.Builder

Sets this meter as applicable to burst traffic only. Defaults to false.

Specified by:

burst in interface Meter.Builder

Returns:

this

withBands

public Meter.Builder withBands(Collection<Band> bands)

Description copied from interface: Meter.Builder

Assigns bands to this meter. There must be at least one band.

Specified by:

withBands in interface Meter.Builder

Parameters:

bands - a collection of bands

Returns:

this

withAnnotations

public DefaultMeter.Builder withAnnotations(Annotations anns)

Description copied from interface: Meter.Builder

Sets the annotations.

Specified by:

withAnnotations in interface Meter.Builder

Parameters:

anns - annotations

Returns:

builder object

build

public DefaultMeter build()

Description copied from interface: Meter.Builder

Builds the meter based on the specified parameters.

Specified by:

build in interface Meter.Builder

Returns:

a meter