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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
|
/**
* 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.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.Iterator;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
/**
* A class that can be used to specify names and a symbol for a unit.
*
* @author Adrien Hopkins
* @since 2019-10-21
*/
public final class NameSymbol {
public static final NameSymbol EMPTY = new NameSymbol(Optional.empty(), Optional.empty(), new HashSet<>());
/**
* Gets a {@code NameSymbol} with a primary name, a symbol and no other names.
*
* @param name name to use
* @param symbol symbol to use
* @return NameSymbol instance
* @since 2019-10-21
* @throws NullPointerException if name or symbol is null
*/
public static final NameSymbol of(final String name, final String symbol) {
return new NameSymbol(Optional.of(name), Optional.of(symbol), new HashSet<>());
}
/**
* Gets a {@code NameSymbol} with a primary name, a symbol and additional names.
*
* @param name name to use
* @param symbol symbol to use
* @param otherNames other names to use
* @return NameSymbol instance
* @since 2019-10-21
* @throws NullPointerException if any argument is null
*/
public static final NameSymbol of(final String name, final String symbol, final Set<String> otherNames) {
return new NameSymbol(Optional.of(name), Optional.of(symbol),
new HashSet<>(Objects.requireNonNull(otherNames, "otherNames must not be null.")));
}
/**
* h * Gets a {@code NameSymbol} with a primary name, a symbol and additional
* names.
*
* @param name name to use
* @param symbol symbol to use
* @param otherNames other names to use
* @return NameSymbol instance
* @since 2019-10-21
* @throws NullPointerException if any argument is null
*/
public static final NameSymbol of(final String name, final String symbol, final String... otherNames) {
return new NameSymbol(Optional.of(name), Optional.of(symbol),
new HashSet<>(Arrays.asList(Objects.requireNonNull(otherNames, "otherNames must not be null."))));
}
/**
* Gets a {@code NameSymbol} with a primary name, a symbol and an additional
* name.
*
* @param name name to use
* @param symbol symbol to use
* @param otherNames other names to use
* @param name2 alternate name
* @return NameSymbol instance
* @since 2019-10-21
* @throws NullPointerException if any argument is null
*/
public static final NameSymbol of(final String name, final String symbol, final String name2) {
final Set<String> otherNames = new HashSet<>();
otherNames.add(Objects.requireNonNull(name2, "name2 must not be null."));
return new NameSymbol(Optional.of(name), Optional.of(symbol), otherNames);
}
/**
* Gets a {@code NameSymbol} with a primary name, a symbol and additional names.
*
* @param name name to use
* @param symbol symbol to use
* @param otherNames other names to use
* @param name2 alternate name
* @param name3 alternate name
* @return NameSymbol instance
* @since 2019-10-21
* @throws NullPointerException if any argument is null
*/
public static final NameSymbol of(final String name, final String symbol, final String name2, final String name3) {
final Set<String> otherNames = new HashSet<>();
otherNames.add(Objects.requireNonNull(name2, "name2 must not be null."));
otherNames.add(Objects.requireNonNull(name3, "name3 must not be null."));
return new NameSymbol(Optional.of(name), Optional.of(symbol), otherNames);
}
/**
* Gets a {@code NameSymbol} with a primary name, a symbol and additional names.
*
* @param name name to use
* @param symbol symbol to use
* @param otherNames other names to use
* @param name2 alternate name
* @param name3 alternate name
* @param name4 alternate name
* @return NameSymbol instance
* @since 2019-10-21
* @throws NullPointerException if any argument is null
*/
public static final NameSymbol of(final String name, final String symbol, final String name2, final String name3,
final String name4) {
final Set<String> otherNames = new HashSet<>();
otherNames.add(Objects.requireNonNull(name2, "name2 must not be null."));
otherNames.add(Objects.requireNonNull(name3, "name3 must not be null."));
otherNames.add(Objects.requireNonNull(name4, "name4 must not be null."));
return new NameSymbol(Optional.of(name), Optional.of(symbol), otherNames);
}
/**
* Gets a {@code NameSymbol} with a primary name, no symbol, and no other names.
*
* @param name name to use
* @return NameSymbol instance
* @since 2019-10-21
* @throws NullPointerException if name is null
*/
public static final NameSymbol ofName(final String name) {
return new NameSymbol(Optional.of(name), Optional.empty(), new HashSet<>());
}
/**
* Gets a {@code NameSymbol} with a primary name, a symbol and additional names.
* <p>
* If any argument is null, this static factory replaces it with an empty
* Optional or empty Set.
* <p>
* If {@code name} is null and {@code otherNames} is not empty, a primary name
* will be picked from {@code otherNames}. This name will not appear in
* getOtherNames().
*
* @param name name to use
* @param symbol symbol to use
* @param otherNames other names to use
* @return NameSymbol instance
* @since 2019-11-26
*/
public static final NameSymbol ofNullable(final String name, final String symbol, final Set<String> otherNames) {
return NameSymbol.create(name, symbol, otherNames == null ? new HashSet<>() : new HashSet<>(otherNames));
}
/**
* Creates a {@code NameSymbol}, ensuring that if primaryName is null and
* otherNames is not empty, one name is moved from otherNames to primaryName
*
* Ensure that otherNames is a copy of the inputted argument.
*/
private static final NameSymbol create(final String name, final String symbol, final Set<String> otherNames) {
final Optional<String> primaryName;
if (name == null && !otherNames.isEmpty()) {
// get primary name and remove it from savedNames
Iterator<String> it = otherNames.iterator();
assert it.hasNext();
primaryName = Optional.of(it.next());
otherNames.remove(primaryName.get());
} else {
primaryName = Optional.ofNullable(name);
}
return new NameSymbol(primaryName, Optional.ofNullable(symbol), otherNames);
}
/**
* h * Gets a {@code NameSymbol} with a primary name, a symbol and additional
* names.
* <p>
* If any argument is null, this static factory replaces it with an empty
* Optional or empty Set.
* <p>
* If {@code name} is null and {@code otherNames} is not empty, a primary name
* will be picked from {@code otherNames}. This name will not appear in
* getOtherNames().
*
* @param name name to use
* @param symbol symbol to use
* @param otherNames other names to use
* @return NameSymbol instance
* @since 2019-11-26
*/
public static final NameSymbol ofNullable(final String name, final String symbol, final String... otherNames) {
return create(name, symbol, otherNames == null ? new HashSet<>() : new HashSet<>(Arrays.asList(otherNames)));
}
/**
* Gets a {@code NameSymbol} with a symbol and no names.
*
* @param symbol symbol to use
* @return NameSymbol instance
* @since 2019-10-21
* @throws NullPointerException if symbol is null
*/
public static final NameSymbol ofSymbol(final String symbol) {
return new NameSymbol(Optional.empty(), Optional.of(symbol), new HashSet<>());
}
private final Optional<String> primaryName;
private final Optional<String> symbol;
private final Set<String> otherNames;
/**
* Creates the {@code NameSymbol}.
*
* @param primaryName primary name of unit
* @param symbol symbol used to represent unit
* @param otherNames other names and/or spellings, should be a mutable copy of
* the argument
* @since 2019-10-21
*/
private NameSymbol(final Optional<String> primaryName, final Optional<String> symbol,
final Set<String> otherNames) {
this.primaryName = primaryName;
this.symbol = symbol;
otherNames.remove(null);
this.otherNames = Collections.unmodifiableSet(otherNames);
}
/**
* @return otherNames
* @since 2019-10-21
*/
public final Set<String> getOtherNames() {
return this.otherNames;
}
/**
* @return primaryName
* @since 2019-10-21
*/
public final Optional<String> getPrimaryName() {
return this.primaryName;
}
/**
* @return symbol
* @since 2019-10-21
*/
public final Optional<String> getSymbol() {
return this.symbol;
}
}
|
