From 4f754b0bc136b972607aa1b39f2358bd98dc4e1c Mon Sep 17 00:00:00 2001
From: Adrien Hopkins <ahopk127@my.yorku.ca>
Date: Wed, 15 Dec 2021 17:52:43 -0500
Subject: Designed the API for a new GUI

Currently "supports" unit conversion, expression conversion and settings loading
---
 .../java/sevenUnits/utils/NamedObjectProduct.java  | 46 ++++++++++++++++++++++
 src/main/java/sevenUnits/utils/ObjectProduct.java  | 15 ++++++-
 2 files changed, 59 insertions(+), 2 deletions(-)
 create mode 100644 src/main/java/sevenUnits/utils/NamedObjectProduct.java

(limited to 'src/main/java/sevenUnits/utils')

diff --git a/src/main/java/sevenUnits/utils/NamedObjectProduct.java b/src/main/java/sevenUnits/utils/NamedObjectProduct.java
new file mode 100644
index 0000000..514f0b1
--- /dev/null
+++ b/src/main/java/sevenUnits/utils/NamedObjectProduct.java
@@ -0,0 +1,46 @@
+/**
+ * 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 sevenUnits.utils;
+
+import java.util.Map;
+
+import sevenUnits.unit.NameSymbol;
+import sevenUnits.unit.Nameable;
+
+/**
+ * An ObjectProduct with name(s) and/or a symbol. Can be created with the
+ * {@link ObjectProduct#withName} method.
+ * 
+ * @author Adrien Hopkins
+ * @since 2021-12-15
+ */
+public class NamedObjectProduct<T> extends ObjectProduct<T>
+		implements Nameable {
+	private final NameSymbol nameSymbol;
+	
+	NamedObjectProduct(final Map<T, Integer> exponents,
+			final NameSymbol nameSymbol) {
+		super(exponents);
+		this.nameSymbol = nameSymbol;
+	}
+	
+	@Override
+	public NameSymbol getNameSymbol() {
+		return this.nameSymbol;
+	}
+	
+}
diff --git a/src/main/java/sevenUnits/utils/ObjectProduct.java b/src/main/java/sevenUnits/utils/ObjectProduct.java
index 5b1b739..d4f88b9 100644
--- a/src/main/java/sevenUnits/utils/ObjectProduct.java
+++ b/src/main/java/sevenUnits/utils/ObjectProduct.java
@@ -26,6 +26,8 @@ import java.util.Objects;
 import java.util.Set;
 import java.util.function.Function;
 
+import sevenUnits.unit.NameSymbol;
+
 /**
  * An immutable product of multiple objects of a type, such as base units. The
  * objects can be multiplied and exponentiated.
@@ -33,7 +35,7 @@ import java.util.function.Function;
  * @author Adrien Hopkins
  * @since 2019-10-16
  */
-public final class ObjectProduct<T> {
+public class ObjectProduct<T> {
 	/**
 	 * Returns an empty ObjectProduct of a certain type
 	 * 
@@ -88,7 +90,7 @@ public final class ObjectProduct<T> {
 	 * @param exponents objects that make up this product
 	 * @since 2019-10-16
 	 */
-	private ObjectProduct(final Map<T, Integer> exponents) {
+	ObjectProduct(final Map<T, Integer> exponents) {
 		this.exponents = Collections.unmodifiableMap(
 				ConditionalExistenceCollections.conditionalExistenceMap(exponents,
 						e -> !Integer.valueOf(0).equals(e.getValue())));
@@ -280,4 +282,13 @@ public final class ObjectProduct<T> {
 		
 		return positiveString + negativeString;
 	}
+	
+	/**
+	 * @return named version of this {@code ObjectProduct}, using data from
+	 *         {@code nameSymbol}
+	 * @since 2021-12-15
+	 */
+	public NamedObjectProduct<T> withName(NameSymbol nameSymbol) {
+		return new NamedObjectProduct<>(this.exponents, nameSymbol);
+	}
 }
-- 
cgit v1.2.3