summaryrefslogtreecommitdiff
path: root/src/main/java/sevenUnits/utils/Nameable.java
diff options
context:
space:
mode:
authorAdrien Hopkins <ahopk127@my.yorku.ca>2022-02-26 09:53:24 -0500
committerAdrien Hopkins <ahopk127@my.yorku.ca>2022-02-26 09:53:24 -0500
commit07c86e02be29aa3d3d878adce62c5c0a9a458e47 (patch)
treef7b13c71beed93f3af0919a2c835414252bf30c7 /src/main/java/sevenUnits/utils/Nameable.java
parentb7eee33a5b162b4057d04d28f45738e3048bf01d (diff)
Implemented unit conversion, with a few problems
TabbedView now displays its units, but with their toString method which shows their definition in addition to their name
Diffstat (limited to 'src/main/java/sevenUnits/utils/Nameable.java')
-rw-r--r--src/main/java/sevenUnits/utils/Nameable.java59
1 files changed, 59 insertions, 0 deletions
diff --git a/src/main/java/sevenUnits/utils/Nameable.java b/src/main/java/sevenUnits/utils/Nameable.java
new file mode 100644
index 0000000..3cfc05a
--- /dev/null
+++ b/src/main/java/sevenUnits/utils/Nameable.java
@@ -0,0 +1,59 @@
+/**
+ * Copyright (C) 2020 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.Optional;
+import java.util.Set;
+
+/**
+ * An object that can hold one or more names, and possibly a symbol. The name
+ * and symbol data should be immutable.
+ *
+ * @since 2020-09-07
+ */
+public interface Nameable {
+ /**
+ * @return a {@code NameSymbol} that contains this object's primary name,
+ * symbol and other names
+ * @since 2020-09-07
+ */
+ NameSymbol getNameSymbol();
+
+ /**
+ * @return set of alternate names
+ * @since 2020-09-07
+ */
+ default Set<String> getOtherNames() {
+ return this.getNameSymbol().getOtherNames();
+ }
+
+ /**
+ * @return preferred name of object
+ * @since 2020-09-07
+ */
+ default Optional<String> getPrimaryName() {
+ return this.getNameSymbol().getPrimaryName();
+ }
+
+ /**
+ * @return short symbol representing object
+ * @since 2020-09-07
+ */
+ default Optional<String> getSymbol() {
+ return this.getNameSymbol().getSymbol();
+ }
+}