summaryrefslogtreecommitdiff
path: root/src/unitConverter/dimension/BaseDimension.java
blob: 0c09dce461dd3c57747cdc24e156ffbc591d1390 (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
/**
 * 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.dimension;

/**
 * A base dimension that makes up {@code UnitDimension} objects.
 * 
 * @author Adrien Hopkins
 * @since 2018-12-22
 * @since v0.1.0
 */
public interface BaseDimension {
	/**
	 * @return the dimension's name
	 * @since 2018-12-22
	 * @since v0.1.0
	 */
	String getName();

	/**
	 * @return a short string (usually one character) that represents this base dimension
	 * @since 2018-12-22
	 * @since v0.1.0
	 */
	String getSymbol();
}