summaryrefslogtreecommitdiff
path: root/src/unitConverter/unit/UnitSystem.java
blob: ce8c2499568e75b703bb723ff47b486f31deb67d (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
/**
 * 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 system of units. Each unit should be aware of its system.
 * 
 * @author Adrien Hopkins
 * @since 2018-12-23
 * @since v0.1.0
 */
public interface UnitSystem {
	/**
	 * Gets a base unit for this system and the provided dimension.
	 * 
	 * @param dimension
	 *            dimension used by base unit
	 * @return base unit
	 * @throws NullPointerException
	 *             if dimension is null
	 * @since 2019-01-25
	 * @since v0.1.0
	 */
	default BaseUnit getBaseUnit(final UnitDimension dimension) {
		Objects.requireNonNull(dimension, "dimension must not be null.");
		return new BaseUnit(dimension, this);
	}

	/**
	 * @return name of system
	 * @since 2018-12-23
	 * @since v0.1.0
	 */
	String getName();
}