summaryrefslogtreecommitdiff
path: root/src/org/unitConverter/newUnits/BaseUnit.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/org/unitConverter/newUnits/BaseUnit.java')
-rw-r--r--src/org/unitConverter/newUnits/BaseUnit.java102
1 files changed, 102 insertions, 0 deletions
diff --git a/src/org/unitConverter/newUnits/BaseUnit.java b/src/org/unitConverter/newUnits/BaseUnit.java
new file mode 100644
index 0000000..69e8b8b
--- /dev/null
+++ b/src/org/unitConverter/newUnits/BaseUnit.java
@@ -0,0 +1,102 @@
+/**
+ * Copyright (C) 2019 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 org.unitConverter.newUnits;
+
+import java.util.Objects;
+
+import org.unitConverter.dimension.BaseDimension;
+import org.unitConverter.math.ObjectProduct;
+
+/**
+ * A unit that other units are defined by.
+ *
+ * @author Adrien Hopkins
+ * @since 2019-10-16
+ */
+public final class BaseUnit implements Unit {
+ private final BaseDimension dimension;
+ private final String name;
+ private final String symbol;
+
+ /**
+ * Creates the {@code BaseUnit}.
+ *
+ * @param dimension
+ * dimension of unit
+ * @param name
+ * name of unit
+ * @param symbol
+ * symbol of unit
+ * @throws NullPointerException
+ * if any argument is null
+ * @since 2019-10-16
+ */
+ private BaseUnit(final BaseDimension dimension, final String name, final String symbol) {
+ this.dimension = Objects.requireNonNull(dimension, "dimension must not be null.");
+ this.name = Objects.requireNonNull(name, "name must not be null.");
+ this.symbol = Objects.requireNonNull(symbol, "symbol must not be null.");
+ }
+
+ @Override
+ public double convertFromBase(final double value) {
+ return value;
+ }
+
+ @Override
+ public double convertToBase(final double value) {
+ return value;
+ }
+
+ @Override
+ public ObjectProduct<BaseUnit> getBase() {
+ return ObjectProduct.oneOf(this);
+ }
+
+ /**
+ * @return dimension
+ * @since 2019-10-16
+ */
+ public final BaseDimension getBaseDimension() {
+ return this.dimension;
+ }
+
+ @Override
+ public ObjectProduct<BaseDimension> getDimension() {
+ return ObjectProduct.oneOf(this.getBaseDimension());
+ }
+
+ /**
+ * @return name
+ * @since 2019-10-16
+ */
+ public final String getName() {
+ return this.name;
+ }
+
+ /**
+ * @return symbol
+ * @since 2019-10-16
+ */
+ public final String getSymbol() {
+ return this.symbol;
+ }
+
+ @Override
+ public String toString() {
+ return String.format("%s (%s)", this.getName(), this.getSymbol());
+ }
+}