1 files changed, 87 insertions, 0 deletions
diff --git a/src/main/java/org/unitConverter/unit/BaseDimension.java b/src/main/java/org/unitConverter/unit/BaseDimension.java
new file mode 100644
index 0000000..8e63a17
--- /dev/null
+++ b/src/main/java/org/unitConverter/unit/BaseDimension.java
@@ -0,0 +1,87 @@
+/**
+ * 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.unit;
+
+import java.util.Objects;
+
+/**
+ * A dimension that defines a {@code BaseUnit}
+ * 
+ * @author Adrien Hopkins
+ * @since 2019-10-16
+ */
+public final class BaseDimension {
+	/**
+	 * Gets a {@code BaseDimension} with the provided name and symbol.
+	 * 
+	 * @param name
+	 *            name of dimension
+	 * @param symbol
+	 *            symbol used for dimension
+	 * @return dimension
+	 * @since 2019-10-16
+	 */
+	public static BaseDimension valueOf(final String name, final String symbol) {
+		return new BaseDimension(name, symbol);
+	}
+
+	/**
+	 * The name of the dimension.
+	 */
+	private final String name;
+	/**
+	 * The symbol used by the dimension. Symbols should be short, generally one or two characters.
+	 */
+	private final String symbol;
+
+	/**
+	 * Creates the {@code BaseDimension}.
+	 * 
+	 * @param name
+	 *            name of unit
+	 * @param symbol
+	 *            symbol of unit
+	 * @throws NullPointerException
+	 *             if any argument is null
+	 * @since 2019-10-16
+	 */
+	private BaseDimension(final String name, final String symbol) {
+		this.name = Objects.requireNonNull(name, "name must not be null.");
+		this.symbol = Objects.requireNonNull(symbol, "symbol must not be null.");
+	}
+
+	/**
+	 * @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());
+	}
+}