org.onosproject.net.config.basics

Class BandwidthCapacity

java.lang.Object

org.onosproject.net.config.Config<ConnectPoint>

org.onosproject.net.config.basics.BandwidthCapacity

@Beta
public class BandwidthCapacity
extends Config<ConnectPoint>

Configuration to specify maximum available bandwidth resource (Capacity) on a port.

Nested Class Summary

Nested classes/interfaces inherited from class org.onosproject.net.config.Config

Config.FieldPresence

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_KEY netcfg ConfigKey for BandwidthCapacity.

Fields inherited from class org.onosproject.net.config.Config

array, delegate, key, mapper, node, object, subject

Constructor Summary

Constructors

Constructor and Description
BandwidthCapacity()

Method Summary

Modifier and Type	Method and Description
Bandwidth	capacity() Available Bandwidth resource (Capacity).
BandwidthCapacity	capacity(Bandwidth bandwidth) Sets the Available Bandwidth resource (Capacity).
boolean	isValid() Indicates whether or not the backing JSON node contains valid data.
String	toString()

Methods inherited from class org.onosproject.net.config.Config

apply, clear, get, get, get, get, get, get, getList, getList, hasField, hasField, hasFields, hasFields, hasOnlyFields, hasOnlyFields, init, isBoolean, isBoolean, isConnectPoint, isConnectPoint, isDecimal, isDecimal, isIntegralNumber, isIntegralNumber, isIpAddress, isIpAddress, isIpPrefix, isIpPrefix, isMacAddress, isMacAddress, isNumber, isNumber, isString, isString, isTpPort, isTpPort, isValidLength, key, node, setList, setOrClear, setOrClear, setOrClear, setOrClear, setOrClear, setOrClear, setOrClear, subject

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_KEY

public static final String CONFIG_KEY

netcfg ConfigKey for BandwidthCapacity.

See Also:

Constant Field Values

Constructor Detail

BandwidthCapacity

public BandwidthCapacity()

Method Detail

isValid

public boolean isValid()

Description copied from class: Config

Indicates whether or not the backing JSON node contains valid data.

Default implementation returns true. Subclasses are expected to override this with their own validation. Implementations are free to throw a RuntimeException if data is invalid.

Overrides:

isValid in class Config<ConnectPoint>

Returns:

true if the data is valid; false otherwise

capacity

public BandwidthCapacity capacity(Bandwidth bandwidth)

Sets the Available Bandwidth resource (Capacity).

Parameters:

bandwidth - value to set.

Returns:

self

capacity

public Bandwidth capacity()

Available Bandwidth resource (Capacity).

Returns:

Bandwidth

toString

public String toString()

Overrides:

toString in class Config<ConnectPoint>