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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
/**
* Copyright (C) 2018 Adrien Hopkins
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package unitConverter.unit;
import java.util.Objects;
import unitConverter.dimension.UnitDimension;
/**
* A unit that is the base for its dimension. It does not have to be for a base dimension, so units like the Newton and
* Joule are still base units.
*
* @author Adrien Hopkins
* @since 2018-12-23
* @since v0.1.0
*/
public final class BaseUnit extends AbstractUnit {
/**
* Is this unit a full base (i.e. m, s, ... but not N, J, ...)
*
* @since 2019-01-15
* @since v0.1.0
*/
private final boolean isFullBase;
/**
* Creates the {@code BaseUnit}.
*
* @param dimension
* dimension measured by unit
* @param system
* system that unit is a part of
* @param name
* name of unit
* @param symbol
* symbol of unit
* @since 2018-12-23
* @since v0.1.0
*/
BaseUnit(final UnitDimension dimension, final UnitSystem system) {
super(dimension, system);
this.isFullBase = dimension.isBase();
}
/**
* @return this unit as a {@code LinearUnit}
* @since 2019-01-25
* @since v0.1.0
*/
public LinearUnit asLinearUnit() {
return this.times(1);
}
@Override
public double convertFromBase(final double value) {
return value;
}
@Override
public double convertToBase(final double value) {
return value;
}
/**
* Divides this unit by another unit.
*
* @param other
* unit to divide by
* @return quotient of two units
* @throws IllegalArgumentException
* if this unit's system is not other's system
* @throws NullPointerException
* if other is null
* @since 2018-12-22
* @since v0.1.0
*/
public BaseUnit dividedBy(final BaseUnit other) {
Objects.requireNonNull(other, "other must not be null.");
if (!this.getSystem().equals(other.getSystem()))
throw new IllegalArgumentException("Incompatible base units for division.");
return new BaseUnit(this.getDimension().dividedBy(other.getDimension()), this.getSystem());
}
/**
* Divides this unit by a divisor
*
* @param divisor
* amount to divide by
* @return quotient
* @since 2018-12-23
* @since v0.1.0
*/
public LinearUnit dividedBy(final double divisor) {
return new LinearUnit(this, 1 / divisor);
}
@Override
public boolean equals(final Object obj) {
if (!(obj instanceof BaseUnit))
return false;
final BaseUnit other = (BaseUnit) obj;
return Objects.equals(this.getSystem(), other.getSystem())
&& Objects.equals(this.getDimension(), other.getDimension());
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = result * prime + this.getSystem().hashCode();
result = result * prime + this.getDimension().hashCode();
return result;
}
/**
* Multiplies this unit by another unit.
*
* @param other
* unit to multiply by
* @return product of two units
* @throws IllegalArgumentException
* if this unit's system is not other's system
* @throws NullPointerException
* if other is null
* @since 2018-12-22
* @since v0.1.0
*/
public BaseUnit times(final BaseUnit other) {
Objects.requireNonNull(other, "other must not be null.");
if (!this.getSystem().equals(other.getSystem()))
throw new IllegalArgumentException("Incompatible base units for multiplication.");
return new BaseUnit(this.getDimension().times(other.getDimension()), this.getSystem());
}
/**
* Multiplies this unit by a multiplier.
*
* @param multiplier
* amount to multiply by
* @return product
* @since 2018-12-23
* @since v0.1.0
*/
public LinearUnit times(final double multiplier) {
return new LinearUnit(this, multiplier);
}
/**
* Returns this unit, but to an exponent.
*
* @param exponent
* exponent
* @return result of exponentiation
* @since 2019-01-15
* @since v0.1.0
*/
public BaseUnit toExponent(final int exponent) {
return this.getSystem().getBaseUnit(this.getDimension().toExponent(exponent));
}
@Override
public String toString() {
return String.format("%s base unit of%s dimension %s", this.getSystem(), this.isFullBase ? " base" : "",
this.getDimension());
}
}
|
