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
|
/**
* Copyright (C) 2019 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 org.unitConverter.unit;
import java.util.HashSet;
import java.util.Objects;
import java.util.Set;
/**
* A unit that other units are defined by.
* <p>
* Note that BaseUnits <b>must</b> have names and symbols. This is because they
* are used for toString code. Therefore, the Optionals provided by
* {@link #getPrimaryName} and {@link #getSymbol} will always contain a value.
*
* @author Adrien Hopkins
* @since 2019-10-16
*/
public final class BaseUnit extends Unit {
/**
* Gets a base unit from the dimension it measures, its name and its symbol.
*
* @param dimension dimension measured by this unit
* @param name name of unit
* @param symbol symbol of unit
* @return base unit
* @since 2019-10-16
*/
public static BaseUnit valueOf(final BaseDimension dimension,
final String name, final String symbol) {
return new BaseUnit(dimension, name, symbol, new HashSet<>());
}
/**
* Gets a base unit from the dimension it measures, its name and its symbol.
*
* @param dimension dimension measured by this unit
* @param name name of unit
* @param symbol symbol of unit
* @return base unit
* @since 2019-10-21
*/
public static BaseUnit valueOf(final BaseDimension dimension,
final String name, final String symbol, final Set<String> otherNames) {
return new BaseUnit(dimension, name, symbol, otherNames);
}
/**
* The dimension measured by this base unit.
*/
private final BaseDimension dimension;
/**
* Creates the {@code BaseUnit}.
*
* @param dimension dimension of unit
* @param primaryName name of unit
* @param symbol symbol of unit
* @throws NullPointerException if any argument is null
* @since 2019-10-16
*/
private BaseUnit(final BaseDimension dimension, final String primaryName,
final String symbol, final Set<String> otherNames) {
super(primaryName, symbol, otherNames);
this.dimension = Objects.requireNonNull(dimension,
"dimension must not be null.");
}
/**
* Returns a {@code LinearUnit} with this unit as a base and a conversion
* factor of 1. This operation must be done in order to allow units to be
* created with operations.
*
* @return this unit as a {@code LinearUnit}
* @since 2019-10-16
*/
public LinearUnit asLinearUnit() {
return LinearUnit.valueOf(this.getBase(), 1);
}
@Override
protected double convertFromBase(final double value) {
return value;
}
@Override
protected double convertToBase(final double value) {
return value;
}
/**
* @return dimension
* @since 2019-10-16
*/
public final BaseDimension getBaseDimension() {
return this.dimension;
}
@Override
public String toString() {
return this.getPrimaryName().orElse("Unnamed unit")
+ (this.getSymbol().isPresent()
? String.format(" (%s)", this.getSymbol().get())
: "");
}
@Override
public BaseUnit withName(final NameSymbol ns) {
Objects.requireNonNull(ns, "ns must not be null.");
if (!ns.getPrimaryName().isPresent())
throw new IllegalArgumentException(
"BaseUnits must have primary names.");
if (!ns.getSymbol().isPresent())
throw new IllegalArgumentException("BaseUnits must have symbols.");
return BaseUnit.valueOf(this.getBaseDimension(),
ns.getPrimaryName().get(), ns.getSymbol().get(),
ns.getOtherNames());
}
}
|
