/
UnitProvider.java
51 lines (44 loc) · 1.71 KB
/
UnitProvider.java
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
/**
* Copyright (c) 2010-2023 Contributors to the openHAB project
*
* See the NOTICE file(s) distributed with this work for additional
* information.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.openhab.core.i18n;
import java.util.Collection;
import javax.measure.Quantity;
import javax.measure.Unit;
import javax.measure.spi.SystemOfUnits;
import org.eclipse.jdt.annotation.NonNullByDefault;
/**
* Provides {@link Unit}s and the current {@link SystemOfUnits}.
*
* @author Henning Treu - Initial contribution
*/
@NonNullByDefault
public interface UnitProvider {
/**
* Retrieves the default {@link Unit} for the given {@link Quantity} according to the current
* {@link SystemOfUnits}.
*
* @param dimension The {@link Quantity}, called dimension here, defines the base unit for the retrieved unit. E.g.
* call {@code getUnit(javax.measure.quantity.Temperature.class)} to retrieve the temperature unit
* according to the current {@link SystemOfUnits}.
* @return The {@link Unit} matching the given {@link Quantity}
* @throws IllegalArgumentException when the dimension is unknown
*/
<T extends Quantity<T>> Unit<T> getUnit(Class<T> dimension) throws IllegalArgumentException;
/**
* Returns the {@link SystemOfUnits} which is currently set, must not be null.
*
* @return the {@link SystemOfUnits} which is currently set, must not be null.
*/
SystemOfUnits getMeasurementSystem();
Collection<Class<? extends Quantity<?>>> getAllDimensions();
}