blob: f653051c190ff25090f6e3d8e1265534e43d09bb (
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
|
/**
* 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.List;
import java.util.Optional;
import sevenUnits.unit.BaseDimension;
import sevenUnits.unit.Unit;
import sevenUnits.utils.NamedObjectProduct;
import sevenUnits.utils.ObjectProduct;
/**
* A View that supports single unit-based conversion
*
* @author Adrien Hopkins
* @since 2021-12-15
*/
public interface UnitConversionView extends View {
/**
* @return unit to convert <em>from</em>
* @since 2021-12-15
*/
Optional<Unit> getFromSelection();
/**
* @return value to convert between the units (specifically, the numeric
* string provided by the user)
* @since 2021-12-15
*/
Optional<String> getInputValue();
/**
* @return selected dimension
* @since 2021-12-15
*/
Optional<ObjectProduct<BaseDimension>> getSelectedDimension();
/**
* @return unit to convert <em>to</em>
* @since 2021-12-15
*/
Optional<Unit> getToSelection();
/**
* Sets the available dimensions for filtering.
*
* @param dimensions dimensions to use
* @since 2021-12-15
*/
void setDimensions(List<NamedObjectProduct<BaseDimension>> dimensions);
/**
* Sets the available units to convert from. {@link #getFromSelection} is not
* required to use one of these units; this method is to be used for views
* that allow the user to select units from a list.
*
* @param units units to convert from
* @since 2021-12-15
*/
void setFromUnits(List<? extends Unit> units);
/**
* Sets the available units to convert to. {@link #getToSelection} is not
* required to use one of these units; this method is to be used for views
* that allow the user to select units from a list.
*
* @param units units to convert to
* @since 2021-12-15
*/
void setToUnits(List<? extends Unit> units);
/**
* Shows the output of a unit conversion.
*
* @param outputString string that shows output of conversion
* @since 2021-12-24
*/
void showUnitConversionOutput(String outputString);
}
|
