org.onlab.util

Class Bandwidth

java.lang.Object

org.onlab.util.Bandwidth

All Implemented Interfaces:

Comparable<Bandwidth>, RichComparable<Bandwidth>

public final class Bandwidth
extends Object
implements RichComparable<Bandwidth>

Representation of bandwidth. Use the static factory method corresponding to the unit (like Kbps) you desire on instantiation.

Method Summary

Modifier and Type	Method and Description
Bandwidth	add(Bandwidth value) Returns a Bandwidth whose value is (this + value).
double	bps() Returns bandwidth in bps.
static Bandwidth	bps(double bps) Creates a new instance with given bandwidth in bps.
int	compareTo(Bandwidth other)
boolean	equals(Object obj)
static Bandwidth	gbps(double gbps) Creates a new instance with given bandwidth in Gbps.
int	hashCode()
static Bandwidth	kbps(double kbps) Creates a new instance with given bandwidth in Kbps.
static Bandwidth	mbps(double mbps) Creates a new instance with given bandwidth in Mbps.
Bandwidth	subtract(Bandwidth value) Returns a Bandwidth whose value is (this - value).
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.onlab.util.RichComparable

isGreaterThan, isLessThan

Method Detail

bps

public static Bandwidth bps(double bps)

Creates a new instance with given bandwidth in bps.

Parameters:

bps - bandwidth value to be assigned

Returns:

Bandwidth instance with given bandwidth

kbps

public static Bandwidth kbps(double kbps)

Creates a new instance with given bandwidth in Kbps.

Parameters:

kbps - bandwidth value to be assigned

Returns:

Bandwidth instance with given bandwidth

mbps

public static Bandwidth mbps(double mbps)

Creates a new instance with given bandwidth in Mbps.

Parameters:

mbps - bandwidth value to be assigned

Returns:

Bandwidth instance with given bandwidth

gbps

public static Bandwidth gbps(double gbps)

Creates a new instance with given bandwidth in Gbps.

Parameters:

gbps - bandwidth value to be assigned

Returns:

Bandwidth instance with given bandwidth

bps

public double bps()

Returns bandwidth in bps.

Returns:

bandwidth in bps.

add

public Bandwidth add(Bandwidth value)

Returns a Bandwidth whose value is (this + value).

Parameters:

value - value to be added to this Frequency

Returns:

this + value

subtract

public Bandwidth subtract(Bandwidth value)

Returns a Bandwidth whose value is (this - value).

Parameters:

value - value to be added to this Frequency

Returns:

this - value

compareTo

public int compareTo(Bandwidth other)

Specified by:

compareTo in interface Comparable<Bandwidth>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object