From 2b9d5b15108bbb2d39e2391df62fd2fd4f701f4e Mon Sep 17 00:00:00 2001
From: Khontrom <khontrom.atakan@gmail.com>
Date: Fri, 9 Aug 2024 15:49:44 +0300
Subject: [PATCH] Descriptions added to Listener classes

---
 README.md                                     |  2 +
 .../iridiumskyblock/IridiumListener.java      | 13 ++++-
 .../ultimateclaims/UltimateListener.java      | 47 +++++++++++++++++--
 src/main/resources/plugin.yml                 |  2 +-
 4 files changed, 59 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 15347655..6cfd5c54 100644
--- a/README.md
+++ b/README.md
@@ -436,6 +436,8 @@ public class Main extends JavaPlugin {
 * [GriefPrevention](https://www.spigotmc.org/resources/griefprevention.1884/)
 * [SuperiorSkyblock2](https://github.com/BG-Software-LLC/SuperiorSkyblock2)
 * [TownyAdvanced](https://www.spigotmc.org/resources/towny-advanced.72694/)
+* [IridiumSkyblock](https://www.spigotmc.org/resources/iridium-skyblock-1-13-1-20-%E2%AD%90now-with-ai%E2%AD%90.62480/)
+* [UltimateClaims](https://songoda.com/product/ultimateclaims-14)
 
 ## Contributing
 
diff --git a/src/main/java/xyz/geik/farmer/integrations/iridiumskyblock/IridiumListener.java b/src/main/java/xyz/geik/farmer/integrations/iridiumskyblock/IridiumListener.java
index 4694bcef..845eff6a 100644
--- a/src/main/java/xyz/geik/farmer/integrations/iridiumskyblock/IridiumListener.java
+++ b/src/main/java/xyz/geik/farmer/integrations/iridiumskyblock/IridiumListener.java
@@ -6,11 +6,22 @@
 import org.bukkit.event.Listener;
 import xyz.geik.farmer.api.FarmerAPI;
 
-
+/**
+ * IridiumSkyblock listener class
+ *
+ * @author Khontrom
+ */
 public class IridiumListener implements Listener {
 
+    /**
+     * Constructor of class
+     */
     public IridiumListener() {}
 
+    /**
+     * Remove farmer on island delete
+     * @param event listener event of delete
+     */
     @EventHandler
     public void islandDeleteEvent(IslandDeleteEvent event){
         String regionID = String.valueOf(event.getIsland().getId());
diff --git a/src/main/java/xyz/geik/farmer/integrations/ultimateclaims/UltimateListener.java b/src/main/java/xyz/geik/farmer/integrations/ultimateclaims/UltimateListener.java
index eb071c58..71cf051b 100644
--- a/src/main/java/xyz/geik/farmer/integrations/ultimateclaims/UltimateListener.java
+++ b/src/main/java/xyz/geik/farmer/integrations/ultimateclaims/UltimateListener.java
@@ -13,10 +13,24 @@
 
 import java.util.UUID;
 
+/**
+ * UltimateClaims listener class
+ *
+ * @author Khontrom
+ */
 public class UltimateListener implements Listener {
 
+    /**
+     * Constructor of class
+     */
     public UltimateListener(){}
 
+    /**
+     * Automatically create farmer
+     * when claim is created
+     *
+     * @param event of event
+     */
     @EventHandler
     public void claimCreateEvent(ClaimCreateEvent event){
         String claimId = String.valueOf(event.getClaim().getId());
@@ -27,6 +41,10 @@ public void claimCreateEvent(ClaimCreateEvent event){
         }
     }
 
+    /**
+     * Adds user to farmer
+     * @param event of event
+     */
     @EventHandler
     public void claimJoinEvent(ClaimMemberAddEvent event){
         String claimId = String.valueOf(event.getClaim().getId());
@@ -37,23 +55,40 @@ public void claimJoinEvent(ClaimMemberAddEvent event){
             farmer.addUser(member, Bukkit.getOfflinePlayer(member).getName(), FarmerPerm.COOP);
     }
 
+    /**
+     * Removes user from farmer if added when leave
+     * @param event of event
+     */
     @EventHandler
     public void claimLeaveEvent(ClaimMemberLeaveEvent event){
-        kickAndLeaveEvent(String.valueOf(event.getClaim().getId()),event.getPlayer().getUniqueId());
+        banAndLeaveEvent(String.valueOf(event.getClaim().getId()),event.getPlayer().getUniqueId());
     }
 
+    /**
+     * Removes user from farmer if added when banned
+     * @param event of event
+     */
     @EventHandler
     public void claimBanEvent(ClaimPlayerBanEvent event){
-        kickAndLeaveEvent(String.valueOf(event.getClaim().getId()),event.getBannedPlayer().getUniqueId());
+        banAndLeaveEvent(String.valueOf(event.getClaim().getId()),event.getBannedPlayer().getUniqueId());
 
     }
 
+    /**
+     * Transfers farmer when claim transfer
+     *
+     * @param event transfer claim event
+     */
     @EventHandler
     public void claimTransferEvent(ClaimTransferOwnershipEvent event){
         FarmerAPI.getFarmerManager()
                 .changeOwner(event.getOldOwner().getUniqueId(), event.getNewOwner().getUniqueId(), String.valueOf(event.getClaim().getId()));
     }
 
+    /**
+     * Remove farmer on claim deletion
+     * @param event of event
+     */
     @EventHandler
     public void claimDeleteEvent(ClaimDeleteEvent event){
         FarmerAPI.getFarmerManager().removeFarmer(String.valueOf(event.getClaim().getId()));
@@ -61,7 +96,13 @@ public void claimDeleteEvent(ClaimDeleteEvent event){
 
 
 
-    private void kickAndLeaveEvent(String claimId, UUID member) {
+    /**
+     * Remove function of ban and leave event
+     *
+     * @param claimId id of claim
+     * @param member member of claim
+     */
+    private void banAndLeaveEvent(String claimId, UUID member) {
         if (!FarmerManager.getFarmers().containsKey(claimId))
             return;
         Farmer farmer = FarmerManager.getFarmers().get(claimId);
diff --git a/src/main/resources/plugin.yml b/src/main/resources/plugin.yml
index d0060f82..961c3c92 100644
--- a/src/main/resources/plugin.yml
+++ b/src/main/resources/plugin.yml
@@ -1,5 +1,5 @@
 name: Farmer
-author: Geik, Amowny, WaterArchery, hyperion, rudde, mehmet-27
+author: Geik, Amowny, WaterArchery, hyperion, rudde, mehmet-27, Khontrom
 main: xyz.geik.farmer.Main
 version: v6-b106
 api-version: 1.13