summaryrefslogtreecommitdiff
path: root/src/main/java/sevenUnitsGUI/StandardDisplayRules.java
blob: 331f5986a4fea47552a0cfa3a2740f241d4eb2fb (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
/**
 * Copyright (C) 2021 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 sevenUnitsGUI;

import java.util.function.Function;

import sevenUnits.utils.UncertainDouble;

/**
 * The default rules for displaying numbers.
 * 
 * Unless otherwise stated, all of this class's functions throw
 * {@link NullPointerException} when they receive a null parameter.
 *
 * @since 2021-12-24
 */
final class StandardDisplayRules {
	/**
	 * Rounds using UncertainDouble's toString method.
	 */
	private static final Function<UncertainDouble, String> SCIENTIFIC_ROUNDING_RULE = new Function<>() {
		@Override
		public String apply(UncertainDouble t) {
			return t.toString(false);
		}
		
		@Override
		public String toString() {
			return "Scientific Rounding";
		}
	};
	
	/**
	 * @return a rule that rounds using UncertainDouble's own toString(false)
	 *         function.
	 * @since 2021-12-24
	 */
	public static final Function<UncertainDouble, String> getScientificRule() {
		return SCIENTIFIC_ROUNDING_RULE;
	}
	
	/**
	 * Gets one of the standard rules from its string representation.
	 *
	 * @param ruleToString string representation of the display rule
	 * @return display rule
	 * @throws IllegalArgumentException if the provided string is not that of a
	 *                                  standard rule.
	 * @since 2021-12-24
	 */
	public static final Function<UncertainDouble, String> getStandardRule(
			String ruleToString) {
		throw new UnsupportedOperationException("Not implemented yet");
	}
	
	private StandardDisplayRules() {
		throw new AssertionError(
				"This is a static utility class, you may not get instances of it.");
	}
}