aboutsummaryrefslogtreecommitdiff
path: root/src/Java/gtPlusPlus/api
diff options
context:
space:
mode:
Diffstat (limited to 'src/Java/gtPlusPlus/api')
-rw-r--r--src/Java/gtPlusPlus/api/interfaces/IPlugin.java19
-rw-r--r--src/Java/gtPlusPlus/api/plugin/Sample_Plugin.java5
2 files changed, 24 insertions, 0 deletions
diff --git a/src/Java/gtPlusPlus/api/interfaces/IPlugin.java b/src/Java/gtPlusPlus/api/interfaces/IPlugin.java
index 99c71a5823..6a8e8c085d 100644
--- a/src/Java/gtPlusPlus/api/interfaces/IPlugin.java
+++ b/src/Java/gtPlusPlus/api/interfaces/IPlugin.java
@@ -1,8 +1,27 @@
package gtPlusPlus.api.interfaces;
+import gtPlusPlus.api.objects.Logger;
+
public interface IPlugin {
+ /**
+ * @return A {@link String} object which returns the {@link IPlugin}'s name.
+ */
public String getPluginName();
+
+ /**
+ * @return
+ * A {@link String} object which returns the {@link IPlugin}'s short name.
+ * This String should only contain 4 Characters.
+ */
+ public String getPluginAbbreviation();
+
+ /**
+ * @param message - A {@link String} object which holds a message to be logged to console.
+ */
+ default void log(String message) {
+ Logger.INFO("["+getPluginAbbreviation()+"] "+message);
+ }
public boolean preInit();
public boolean init();
diff --git a/src/Java/gtPlusPlus/api/plugin/Sample_Plugin.java b/src/Java/gtPlusPlus/api/plugin/Sample_Plugin.java
index d2959df58d..82671acaea 100644
--- a/src/Java/gtPlusPlus/api/plugin/Sample_Plugin.java
+++ b/src/Java/gtPlusPlus/api/plugin/Sample_Plugin.java
@@ -29,4 +29,9 @@ public final class Sample_Plugin implements IPlugin {
return "Sample Plugin";
}
+ @Override
+ public String getPluginAbbreviation() {
+ return "Test";
+ }
+
}