Bandwidth.java
3.58 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
/*
* Copyright 2015 Open Networking Laboratory
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.onlab.util;
import com.google.common.collect.ComparisonChain;
import java.util.Objects;
/**
* Representation of bandwidth.
* Use the static factory method corresponding to the unit (like Kbps) you desire on instantiation.
*/
public final class Bandwidth implements RichComparable<Bandwidth> {
private final double bps;
/**
* Creates a new instance with given bandwidth.
*
* @param bps bandwidth value to be assigned
*/
private Bandwidth(double bps) {
this.bps = bps;
}
// Constructor for serialization
private Bandwidth() {
this.bps = 0;
}
/**
* Creates a new instance with given bandwidth in bps.
*
* @param bps bandwidth value to be assigned
* @return {@link Bandwidth} instance with given bandwidth
*/
public static Bandwidth bps(double bps) {
return new Bandwidth(bps);
}
/**
* Creates a new instance with given bandwidth in Kbps.
*
* @param kbps bandwidth value to be assigned
* @return {@link Bandwidth} instance with given bandwidth
*/
public static Bandwidth kbps(double kbps) {
return bps(kbps * 1_000L);
}
/**
* Creates a new instance with given bandwidth in Mbps.
*
* @param mbps bandwidth value to be assigned
* @return {@link Bandwidth} instance with given bandwidth
*/
public static Bandwidth mbps(double mbps) {
return bps(mbps * 1_000_000L);
}
/**
* Creates a new instance with given bandwidth in Gbps.
*
* @param gbps bandwidth value to be assigned
* @return {@link Bandwidth} instance with given bandwidth
*/
public static Bandwidth gbps(double gbps) {
return bps(gbps * 1_000_000_000L);
}
/**
* Returns bandwidth in bps.
*
* @return bandwidth in bps.
*/
public double bps() {
return bps;
}
/**
* Returns a Bandwidth whose value is (this + value).
*
* @param value value to be added to this Frequency
* @return this + value
*/
public Bandwidth add(Bandwidth value) {
return bps(this.bps + value.bps);
}
/**
* Returns a Bandwidth whose value is (this - value).
*
* @param value value to be added to this Frequency
* @return this - value
*/
public Bandwidth subtract(Bandwidth value) {
return bps(this.bps - value.bps);
}
@Override
public int compareTo(Bandwidth other) {
return ComparisonChain.start()
.compare(this.bps, other.bps)
.result();
}
@Override
public boolean equals(Object obj) {
if (obj instanceof Bandwidth) {
Bandwidth that = (Bandwidth) obj;
return Objects.equals(this.bps, that.bps);
}
return false;
}
@Override
public int hashCode() {
return Long.hashCode(Double.doubleToLongBits(bps));
}
@Override
public String toString() {
return String.valueOf(this.bps);
}
}