summaryrefslogtreecommitdiff
path: root/src/main/java/sevenUnits/unit/FunctionalUnit.java
blob: 41db164454cf4156af5361d3c169b48afb1c0955 (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
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
/**
 * Copyright (C) 2019, 2021, 2022, 2024, 2025 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;
import java.util.function.DoubleUnaryOperator;

import sevenUnits.utils.NameSymbol;
import sevenUnits.utils.ObjectProduct;

/**
 * A unit that uses functional objects to convert to and from its base.
 * 
 * @author Adrien Hopkins
 * @since 2019-05-22
 * @since v0.3.0
 */
final class FunctionalUnit extends Unit {
	/**
	 * A function that accepts a value expressed in the unit's base and returns
	 * that value expressed in this unit.
	 * 
	 * @since 2019-05-22
	 * @since v0.3.0
	 */
	private final DoubleUnaryOperator converterFrom;

	/**
	 * A function that accepts a value expressed in the unit and returns that
	 * value expressed in the unit's base.
	 * 
	 * @since 2019-05-22
	 * @since v0.3.0
	 */
	private final DoubleUnaryOperator converterTo;

	/**
	 * Creates the {@code FunctionalUnit}.
	 * 
	 * @param base          unit's base
	 * @param converterFrom function that accepts a value expressed in the unit's
	 *                      base and returns that value expressed in this unit.
	 * @param converterTo   function that accepts a value expressed in the unit
	 *                      and returns that value expressed in the unit's base.
	 * @throws NullPointerException if any argument is null
	 * @since 2019-05-22
	 * @since v0.3.0
	 */
	public FunctionalUnit(final ObjectProduct<BaseUnit> base,
			final DoubleUnaryOperator converterFrom,
			final DoubleUnaryOperator converterTo) {
		super(base, NameSymbol.EMPTY);
		this.converterFrom = Objects.requireNonNull(converterFrom,
				"converterFrom must not be null.");
		this.converterTo = Objects.requireNonNull(converterTo,
				"converterTo must not be null.");
	}

	/**
	 * Creates the {@code FunctionalUnit}.
	 * 
	 * @param base          unit's base
	 * @param converterFrom function that accepts a value expressed in the unit's
	 *                      base and returns that value expressed in this unit.
	 * @param converterTo   function that accepts a value expressed in the unit
	 *                      and returns that value expressed in the unit's base.
	 * @param ns            name and symbol of resulting unit
	 * @throws NullPointerException if any argument is null
	 * @since 2019-05-22
	 * @since v0.3.0
	 */
	public FunctionalUnit(final ObjectProduct<BaseUnit> base,
			final DoubleUnaryOperator converterFrom,
			final DoubleUnaryOperator converterTo, final NameSymbol ns) {
		super(base, ns);
		this.converterFrom = Objects.requireNonNull(converterFrom,
				"converterFrom must not be null.");
		this.converterTo = Objects.requireNonNull(converterTo,
				"converterTo must not be null.");
	}

	/**
	 * {@inheritDoc}
	 * 
	 * Uses {@code converterFrom} to convert.
	 */
	@Override
	public double convertFromBase(final double value) {
		return this.converterFrom.applyAsDouble(value);
	}

	/**
	 * {@inheritDoc}
	 * 
	 * Uses {@code converterTo} to convert.
	 */
	@Override
	public double convertToBase(final double value) {
		return this.converterTo.applyAsDouble(value);
	}

}