From c82e3b3b2de0633317ec8fc85925e91422820597 Mon Sep 17 00:00:00 2001
From: "Benjamin J. Culkin" <bjculkin@mix.wvu.edu>
Date: Sun, 8 Oct 2017 22:39:59 -0300
Subject: Start splitting into maven modules

---
 .../bjc/utils/components/IDescribedComponent.java  | 64 ++++++++++++++++++++++
 1 file changed, 64 insertions(+)
 create mode 100644 base/src/main/java/bjc/utils/components/IDescribedComponent.java

(limited to 'base/src/main/java/bjc/utils/components/IDescribedComponent.java')

diff --git a/base/src/main/java/bjc/utils/components/IDescribedComponent.java b/base/src/main/java/bjc/utils/components/IDescribedComponent.java
new file mode 100644
index 0000000..952b375
--- /dev/null
+++ b/base/src/main/java/bjc/utils/components/IDescribedComponent.java
@@ -0,0 +1,64 @@
+package bjc.utils.components;
+
+/**
+ * Represents a optional component that has status information associated with
+ * it
+ *
+ * @author ben
+ *
+ */
+public interface IDescribedComponent extends Comparable<IDescribedComponent> {
+	/**
+	 * Get the author of this component
+	 *
+	 * Providing this is optional, with "Anonymous" as the default author
+	 *
+	 * @return The author of the component
+	 */
+	default String getAuthor() {
+		return "Anonymous";
+	}
+
+	/**
+	 * Get the description of this component
+	 *
+	 * Providing this is optional, with the default being a note that no
+	 * description was provided
+	 *
+	 * @return The description of the component
+	 */
+	default String getDescription() {
+		return "No description provided.";
+	}
+
+	/**
+	 * Get the name of this component.
+	 *
+	 * This is the only thing required of all components
+	 *
+	 * @return The name of the component
+	 */
+	String getName();
+
+	/**
+	 * Get the version of this component
+	 *
+	 * Providing this is optional, with "1" as the default version
+	 *
+	 * @return The version of this component
+	 */
+	default int getVersion() {
+		return 1;
+	}
+
+	@Override
+	default int compareTo(final IDescribedComponent o) {
+		int res = getName().compareTo(o.getName());
+
+		if (res == 0) {
+			res = getVersion() - o.getVersion();
+		}
+
+		return res;
+	}
+}
\ No newline at end of file
-- 
cgit v1.2.3