summaryrefslogtreecommitdiff
path: root/base/src/main/java/bjc/utils/components/IDescribedComponent.java
diff options
context:
space:
mode:
authorBen Culkin <scorpress@gmail.com>2020-12-03 19:28:15 -0500
committerBen Culkin <scorpress@gmail.com>2020-12-03 19:28:15 -0500
commitf3814a84f8471684cd483347db4fb7b107c2e635 (patch)
tree7ed1061ee69ef50cd1494cfacc866b271b8d1163 /base/src/main/java/bjc/utils/components/IDescribedComponent.java
parenta2c7425458f645802a352abc4783e0afc73dba13 (diff)
Rename interfaces to match Java style
Rename several interfaces that were in the style IWhatever, which Java doesn't use
Diffstat (limited to 'base/src/main/java/bjc/utils/components/IDescribedComponent.java')
-rw-r--r--base/src/main/java/bjc/utils/components/IDescribedComponent.java64
1 files changed, 0 insertions, 64 deletions
diff --git a/base/src/main/java/bjc/utils/components/IDescribedComponent.java b/base/src/main/java/bjc/utils/components/IDescribedComponent.java
deleted file mode 100644
index ae3e06c..0000000
--- a/base/src/main/java/bjc/utils/components/IDescribedComponent.java
+++ /dev/null
@@ -1,64 +0,0 @@
-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;
- }
-}