org.onosproject.net.meter

Class DefaultMeterRequest.Builder

java.lang.Object

org.onosproject.net.meter.DefaultMeterRequest.Builder

All Implemented Interfaces:

MeterRequest.Builder

Enclosing class:

DefaultMeterRequest

public static final class DefaultMeterRequest.Builder
extends Object
implements MeterRequest.Builder

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
MeterRequest	add() Requests the addition of a meter.
MeterRequest.Builder	burst() Sets this meter as applicable to burst traffic only.
MeterRequest.Builder	forDevice(DeviceId deviceId) Assigns the target device for this meter.
MeterRequest.Builder	fromApp(ApplicationId appId) Assigns the application that built this meter.
MeterRequest	remove() Requests the removal of a meter.
MeterRequest.Builder	withBands(Collection<Band> bands) Assigns bands to this meter.
MeterRequest.Builder	withContext(MeterContext context) Assigns an execution context for this meter request.
MeterRequest.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 MeterRequest.Builder forDevice(DeviceId deviceId)

Description copied from interface: MeterRequest.Builder

Assigns the target device for this meter.

Specified by:

forDevice in interface MeterRequest.Builder

Parameters:

deviceId - a device id

Returns:

this

fromApp

public MeterRequest.Builder fromApp(ApplicationId appId)

Description copied from interface: MeterRequest.Builder

Assigns the application that built this meter.

Specified by:

fromApp in interface MeterRequest.Builder

Parameters:

appId - an application id

Returns:

this

withUnit

public MeterRequest.Builder withUnit(Meter.Unit unit)

Description copied from interface: MeterRequest.Builder

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

Specified by:

withUnit in interface MeterRequest.Builder

Parameters:

unit - a unit

Returns:

this

burst

public MeterRequest.Builder burst()

Description copied from interface: MeterRequest.Builder

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

Specified by:

burst in interface MeterRequest.Builder

Returns:

this

withBands

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

Description copied from interface: MeterRequest.Builder

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

Specified by:

withBands in interface MeterRequest.Builder

Parameters:

bands - a collection of bands

Returns:

this

withContext

public MeterRequest.Builder withContext(MeterContext context)

Description copied from interface: MeterRequest.Builder

Assigns an execution context for this meter request.

Specified by:

withContext in interface MeterRequest.Builder

Parameters:

context - a meter context

Returns:

this

add

public MeterRequest add()

Description copied from interface: MeterRequest.Builder

Requests the addition of a meter.

Specified by:

add in interface MeterRequest.Builder

Returns:

a meter request

remove

public MeterRequest remove()

Description copied from interface: MeterRequest.Builder

Requests the removal of a meter.

Specified by:

remove in interface MeterRequest.Builder

Returns:

a meter request