blob: d5e98ca7849b9b31e43f43a6f54362d8376dfc3a (
plain)
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
|
/**
* 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 sevenUnits.unit;
import java.util.Objects;
/**
* A dimension that defines a {@code BaseUnit}
*
* @author Adrien Hopkins
* @since 2019-10-16
*/
public final class BaseDimension {
/**
* Gets a {@code BaseDimension} with the provided name and symbol.
*
* @param name
* name of dimension
* @param symbol
* symbol used for dimension
* @return dimension
* @since 2019-10-16
*/
public static BaseDimension valueOf(final String name, final String symbol) {
return new BaseDimension(name, symbol);
}
/**
* The name of the dimension.
*/
private final String name;
/**
* The symbol used by the dimension. Symbols should be short, generally one or two characters.
*/
private final String symbol;
/**
* Creates the {@code BaseDimension}.
*
* @param name
* name of unit
* @param symbol
* symbol of unit
* @throws NullPointerException
* if any argument is null
* @since 2019-10-16
*/
private BaseDimension(final String name, final String symbol) {
this.name = Objects.requireNonNull(name, "name must not be null.");
this.symbol = Objects.requireNonNull(symbol, "symbol must not be null.");
}
/**
* @return name
* @since 2019-10-16
*/
public final String getName() {
return this.name;
}
/**
* @return symbol
* @since 2019-10-16
*/
public final String getSymbol() {
return this.symbol;
}
@Override
public String toString() {
return String.format("%s (%s)", this.getName(), this.getSymbol());
}
}
|
