Updated GitHub repository. Added ClansLiteAPI instance.

Author: Loving11ish

src/main/java/me/loving11ish/clans/api/ClansLiteAPI.java

@@ -2,8 +2,10 @@
 
 import me.loving11ish.clans.api.models.Clan;
 import me.loving11ish.clans.api.models.ClanPlayer;
+import org.bukkit.Bukkit;
 import org.bukkit.OfflinePlayer;
 import org.bukkit.entity.Player;
+import org.bukkit.plugin.RegisteredServiceProvider;
 
 import java.io.IOException;
 import java.util.HashMap;
@@ -17,61 +19,72 @@
  */
 public interface ClansLiteAPI {
 
+    /**
+     *
+     * @return Returns the instance of the ClansLiteAPI.
+     */
+    static ClansLiteAPI getInstance() {
+        RegisteredServiceProvider<ClansLiteAPI> registration = Bukkit.getServicesManager().getRegistration(ClansLiteAPI.class);
+        if (registration == null) {
+            return null;
+        }
+        return registration.getProvider();
+    }
 
     /**
      *
      * @return Returns true if the plugin was enabled successfully, otherwise returns false.
      */
-    public boolean isPluginEnabled();
+    boolean isPluginEnabled();
 
     /**
      *
      * @return Returns a string of text that contains the full server package.
      */
-    public String getServerPackage();
+    String getServerPackage();
 
     /**
      *
      * @return Returns an integer that is the base major server version.
      */
-    public int getMajorServerVersion();
+    int getMajorServerVersion();
 
     /**
      *
      * @return Returns `true` if the server or network is able to connect to the Mojang auth servers. Otherwise, returns `false`.
      *
      */
-    public boolean isServerRunningOnline();
+    boolean isServerRunningOnline();
 
     /**
      *
      * @return Returns `true` if your current ClansLite plugin version does NOT mach the latest version listed on SpigotMC.
      */
-    public boolean isClansLitePluginUpdateAvailable();
+    boolean isClansLitePluginUpdateAvailable();
 
     /**
      *
      * @return Returns the URL of the development build repository for ClansLite.
      */
-    public String getClansLiteDevelopmentBuildRepository();
+    String getClansLiteDevelopmentBuildRepository();
 
     /**
      *
      * @return Returns a HashMap of all connected Bedrock players with a key of the Player and a value of their Java UUID.
      */
-    public HashMap<Player, String> getConnectedBedrockPlayers();
+    HashMap<Player, String> getConnectedBedrockPlayers();
 
     /**
      *
      * @return Returns a HashMap of all stored Clans.
      */
-    public HashMap<UUID, Clan> getAllClans();
+    HashMap<UUID, Clan> getAllClans();
 
     /**
      *
      * @return Returns a HashMap of all stored ClanPlayers.
      */
-    public HashMap<UUID, ClanPlayer> getAllClanPlayers();
+    HashMap<UUID, ClanPlayer> getAllClanPlayers();
 
     /**
      * THIS METHOD IS NOT RECOMMENDED FOR USE ON LARGE SERVERS.
@@ -80,14 +93,14 @@ public interface ClansLiteAPI {
      * @param maxListSize The maximum size of the list of Clans to return.
      * @return Returns a list of Clans sorted by clan points.
      */
-    public List<Clan> getTopClansByClanPointsOnDemand(int maxListSize);
+    List<Clan> getTopClansByClanPointsOnDemand(int maxListSize);
 
     /**
      * The returned list is cached and updated asynchronously every 10 minutes.
      *
      * @return Returns a list of Clans sorted by clan points.
      */
-    public List<Clan> getTopClansByClanPointsCache();
+    List<Clan> getTopClansByClanPointsCache();
 
     /**
      * THIS METHOD IS NOT RECOMMENDED FOR USE ON LARGE SERVERS.
@@ -96,28 +109,28 @@ public interface ClansLiteAPI {
      * @param maxListSize The maximum size of the list of ClanPlayers to return.
      * @return Returns a list of ClanPlayers sorted by clan points.
      */
-    public List<ClanPlayer> getTopClanPlayersByClanPointsOnDemand(int maxListSize);
+    List<ClanPlayer> getTopClanPlayersByClanPointsOnDemand(int maxListSize);
 
     /**
      * The returned list is cached and updated asynchronously every 10 minutes.
      *
      * @return Returns a list of ClanPlayers sorted by Player points.
      */
-    public List<ClanPlayer> getTopClanPlayersByPlayerPointsCache();
+    List<ClanPlayer> getTopClanPlayersByPlayerPointsCache();
 
     /**
      *
      * @param player The Bukkit Player object to get a ClanPlayer from.
      * @return Returns a ClanPlayer object or null if not found.
      */
-    public ClanPlayer getClanPlayerByBukkitPlayer(Player player);
+    ClanPlayer getClanPlayerByBukkitPlayer(Player player);
 
     /**
      *
      * @param offlinePlayer The Bukkit OfflinePlayer object to get a ClanPlayer from.
      * @return Returns a ClanPlayer object or null if not found.
      */
-    public ClanPlayer getClanPlayerByBukkitOfflinePlayer(OfflinePlayer offlinePlayer);
+    ClanPlayer getClanPlayerByBukkitOfflinePlayer(OfflinePlayer offlinePlayer);
 
     /**
      * THIS WILL RETURN NULL IF THE PLAYER HAS NEVER JOINED THE SERVER BEFORE.
@@ -128,54 +141,54 @@ public interface ClansLiteAPI {
      * @param lastKnownName The last known name of the player to get a Bukkit OfflinePlayer from.
      * @return Returns a Bukkit OfflinePlayer object or null if not found.
      */
-    public OfflinePlayer getBukkitOfflinePlayerByLastKnownName(String lastKnownName);
+    OfflinePlayer getBukkitOfflinePlayerByLastKnownName(String lastKnownName);
 
     /**
      *
      * @param uuid The UUID of the player to get a Bukkit OfflinePlayer from.
      * @return Returns a Bukkit OfflinePlayer object or null if not found.
      */
-    public OfflinePlayer getBukkitOfflinePlayerByUUID(UUID uuid);
+    OfflinePlayer getBukkitOfflinePlayerByUUID(UUID uuid);
 
     /**
      * This method will only return a clan if the player is a member of a clan and NOT the clan owner.
      *
      * @param player The Bukkit Player object to get a Clan from.
      * @return Returns a Clan object or null if not found.
      */
-    public Clan getClanByBukkitPlayer(Player player);
+    Clan getClanByBukkitPlayer(Player player);
 
     /**
      * This method will only return a clan if the offline player is a member of a clan and NOT the clan owner.
      *
      * @param offlinePlayer The Bukkit OfflinePlayer object to get a Clan from.
      * @return Returns a Clan object or null if not found.
      */
-    public Clan getClanByBukkitOfflinePlayer(OfflinePlayer offlinePlayer);
+    Clan getClanByBukkitOfflinePlayer(OfflinePlayer offlinePlayer);
 
     /**
      * This method will only return a clan if the player is the owner of a clan.
      *
      * @param player The Bukkit Player object to get a Clan from.
      * @return Returns a Clan object or null if not found.
      */
-    public Clan getClanByBukkitPlayerOwner(Player player);
+    Clan getClanByBukkitPlayerOwner(Player player);
 
     /**
      * This method will only return a clan if the offline player is the owner of a clan.
      *
      * @param offlinePlayer The Bukkit OfflinePlayer object to get a Clan from.
      * @return Returns a Clan object or null if not found.
      */
-    public Clan getClanByBukkitOfflinePlayerOwner(OfflinePlayer offlinePlayer);
+    Clan getClanByBukkitOfflinePlayerOwner(OfflinePlayer offlinePlayer);
 
     /**
      * This method will only return a clan if the clan name is found.
      *
      * @param clanName The name of the clan to get a Clan from.
      * @return Returns a Clan object or null if not found.
      */
-    public Clan getClanByClanName(String clanName);
+    Clan getClanByClanName(String clanName);
 
     /**
      * This method will perform multiple checks to see if the new clan is valid and can be created.
@@ -186,15 +199,15 @@ public interface ClansLiteAPI {
      * @param clanName The name of the clan to create. (This cannot be changed later & cannot contain color codes)
      * @return Returns a Clan object.
      */
-    public Clan createClan(Player player, String clanName);
+    Clan createClan(Player player, String clanName);
 
     /**
      *
      * @param player The Bukkit Player object to delete a Clan from.
      * @return Returns true if the Clan was deleted successfully, otherwise returns false.
      * @throws IOException Throws an IOException if the Clan could not be deleted.
      */
-    public boolean deleteClan(Player player) throws IOException;
+    boolean deleteClan(Player player) throws IOException;
 
     /**
      * This method will perform multiple checks to see if the new prefix is valid and can be set.
@@ -203,7 +216,7 @@ public interface ClansLiteAPI {
      * @param player The Bukkit Player object to get the clan from.
      * @param prefix The new prefix to set for the clan.
      */
-    public void setClanPrefix(Player player, String prefix);
+    void setClanPrefix(Player player, String prefix);
 
     /**
      * This method will perform multiple checks to see if the player is not already a member of a clan or a clan owner.
@@ -212,7 +225,7 @@ public interface ClansLiteAPI {
      * @param player The Bukkit Player object to add to the Clan.
      * @return Returns true if the player was added to the Clan successfully, otherwise returns false.
      */
-    public boolean addClanMember(Clan clan, Player player);
+    boolean addClanMember(Clan clan, Player player);
 
     /**
      * This method will perform multiple checks to see if the player is in a clan and not a clan owner.
@@ -221,7 +234,7 @@ public interface ClansLiteAPI {
      * @param player The Bukkit Player object to remove from the Clan.
      * @return Returns true if the player was removed from the Clan successfully, otherwise returns false.
      */
-    public boolean removeClanMember(Clan clan, Player player);
+    boolean removeClanMember(Clan clan, Player player);
 
     /**
      * This method will perform multiple checks to see if the player is in a clan and not a clan owner.
@@ -230,6 +243,6 @@ public interface ClansLiteAPI {
      * @param offlinePlayer The Bukkit OfflinePlayer object to remove from the Clan.
      * @return Returns true if the player was removed from the Clan successfully, otherwise returns false.
      */
-    public boolean removeOfflineClanMember(Clan clan, OfflinePlayer offlinePlayer);
+    boolean removeOfflineClanMember(Clan clan, OfflinePlayer offlinePlayer);
 
 }