Fixes JavaDoc warnings. (#164)

@inheritDoc cannot be used on Constructors.

Fixed some other warnings.
This commit is contained in:
tastybento 2019-08-05 03:00:03 -07:00 committed by BONNe
parent 76fb30be36
commit a50d00b2e7
14 changed files with 4738 additions and 4678 deletions

View File

@ -29,10 +29,10 @@ public class ChallengeDataRequestHandler extends AddonRequestHandler
} }
/** /* (non-Javadoc)
* @param metaData Required meta data. * @param metaData Required meta data.
* @return Map that returns information about challenges * @return Map that returns information about challenges
* @see AddonRequestHandler#handle(Map<String, Object>) * @see world.bentobox.bentobox.api.addons.request.AddonRequestHandler#handle(java.util.Map)
*/ */
@Override @Override
public Object handle(Map<String, Object> metaData) public Object handle(Map<String, Object> metaData)

View File

@ -26,10 +26,10 @@ public class ChallengeListRequestHandler extends AddonRequestHandler
} }
/** /* (non-Javadoc)
* @see world.bentobox.bentobox.api.addons.request.AddonRequestHandler#handle(java.util.Map)
* @param metaData Required meta data. * @param metaData Required meta data.
* @return Set of strings that contains completed challenges. * @return Set of strings that contains completed challenges.
* @see AddonRequestHandler#handle(Map <String, Object>)
*/ */
@Override @Override
public Object handle(Map<String, Object> metaData) public Object handle(Map<String, Object> metaData)

View File

@ -29,10 +29,10 @@ public class CompletedChallengesRequestHandler extends AddonRequestHandler
} }
/** /* (non-Javadoc)
* @see world.bentobox.bentobox.api.addons.request.AddonRequestHandler#handle(java.util.Map)
* @param metaData Required meta data. * @param metaData Required meta data.
* @return Set of strings that contains completed challenges. * @return Set of strings that contains completed challenges.
* @see AddonRequestHandler#handle(Map<String, Object>)
*/ */
@Override @Override
public Object handle(Map<String, Object> metaData) public Object handle(Map<String, Object> metaData)

View File

@ -27,10 +27,10 @@ public class LevelDataRequestHandler extends AddonRequestHandler
} }
/** /* (non-Javadoc)
* @see world.bentobox.bentobox.api.addons.request.AddonRequestHandler#handle(java.util.Map)
* @param metaData Required meta data. * @param metaData Required meta data.
* @return Map that returns information about level * @return Map that returns information about level
* @see AddonRequestHandler#handle(Map <String, Object>)
*/ */
@Override @Override
public Object handle(Map<String, Object> metaData) public Object handle(Map<String, Object> metaData)

View File

@ -27,10 +27,10 @@ public class LevelListRequestHandler extends AddonRequestHandler
} }
/** /* (non-Javadoc)
* @see world.bentobox.bentobox.api.addons.request.AddonRequestHandler#handle(java.util.Map)
* @param metaData Required meta data. * @param metaData Required meta data.
* @return List of strings that contains levels in given world * @return List of strings that contains levels in given world
* @see AddonRequestHandler#handle(Map <String, Object>)
*/ */
@Override @Override
public Object handle(Map<String, Object> metaData) public Object handle(Map<String, Object> metaData)

View File

@ -1,6 +1,11 @@
package world.bentobox.challenges.panel; package world.bentobox.challenges.panel;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import org.bukkit.Material; import org.bukkit.Material;
import org.bukkit.World; import org.bukkit.World;
import org.bukkit.entity.EntityType; import org.bukkit.entity.EntityType;
@ -16,10 +21,6 @@ import org.bukkit.inventory.meta.SkullMeta;
import org.bukkit.inventory.meta.SpawnEggMeta; import org.bukkit.inventory.meta.SpawnEggMeta;
import org.bukkit.inventory.meta.TropicalFishBucketMeta; import org.bukkit.inventory.meta.TropicalFishBucketMeta;
import org.bukkit.potion.PotionData; import org.bukkit.potion.PotionData;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import world.bentobox.bentobox.api.panels.PanelItem; import world.bentobox.bentobox.api.panels.PanelItem;
import world.bentobox.bentobox.api.panels.builders.PanelItemBuilder; import world.bentobox.bentobox.api.panels.builders.PanelItemBuilder;
@ -213,6 +214,7 @@ public abstract class CommonGUI
* @param button Button that must be returned. * @param button Button that must be returned.
* @return PanelItem with requested functionality. * @return PanelItem with requested functionality.
*/ */
@SuppressWarnings("deprecation")
protected PanelItem getButton(CommonButtons button) protected PanelItem getButton(CommonButtons button)
{ {
ItemStack icon; ItemStack icon;

View File

@ -23,9 +23,14 @@ import world.bentobox.challenges.utils.GuiUtils;
public class GameModesGUI extends CommonGUI public class GameModesGUI extends CommonGUI
{ {
/** /**
* {@inheritDoc}
* @param adminMode - boolean that indicate if Gui is in admin mode. * @param adminMode - boolean that indicate if Gui is in admin mode.
* @param gameModeAddons - List with GameModes where Challenges addon is integrated. * @param gameModeAddons - List with GameModes where Challenges addon is integrated.
* @param addon Addon where panel operates.
* @param world World from which panel was created.
* @param user User who created panel.
* @param topLabel Command top label which creates panel (f.e. island or ai)
* @param permissionPrefix Command permission prefix (f.e. bskyblock.)
*/ */
public GameModesGUI(ChallengesAddon addon, public GameModesGUI(ChallengesAddon addon,
World world, World world,

View File

@ -5,15 +5,11 @@ import org.bukkit.Material;
import org.bukkit.World; import org.bukkit.World;
import org.bukkit.inventory.ItemStack; import org.bukkit.inventory.ItemStack;
import java.util.Optional;
import net.wesjd.anvilgui.AnvilGUI; import net.wesjd.anvilgui.AnvilGUI;
import world.bentobox.bentobox.api.addons.GameModeAddon;
import world.bentobox.bentobox.api.panels.PanelItem; import world.bentobox.bentobox.api.panels.PanelItem;
import world.bentobox.bentobox.api.panels.builders.PanelBuilder; import world.bentobox.bentobox.api.panels.builders.PanelBuilder;
import world.bentobox.bentobox.api.panels.builders.PanelItemBuilder; import world.bentobox.bentobox.api.panels.builders.PanelItemBuilder;
import world.bentobox.bentobox.api.user.User; import world.bentobox.bentobox.api.user.User;
import world.bentobox.bentobox.util.Util;
import world.bentobox.challenges.ChallengesAddon; import world.bentobox.challenges.ChallengesAddon;
import world.bentobox.challenges.panel.CommonGUI; import world.bentobox.challenges.panel.CommonGUI;
import world.bentobox.challenges.panel.util.ConfirmationGUI; import world.bentobox.challenges.panel.util.ConfirmationGUI;
@ -71,9 +67,12 @@ public class AdminGUI extends CommonGUI
// Section: Constructor // Section: Constructor
// --------------------------------------------------------------------- // ---------------------------------------------------------------------
/** /**
* {@inheritDoc} * @param addon Addon where panel operates.
* @param world World from which panel was created.
* @param user User who created panel.
* @param topLabel Command top label which creates panel (f.e. island or ai)
* @param permissionPrefix Command permission prefix (f.e. bskyblock.)
*/ */
public AdminGUI(ChallengesAddon addon, public AdminGUI(ChallengesAddon addon,
World world, World world,
@ -93,6 +92,7 @@ public class AdminGUI extends CommonGUI
/** /**
* {@inheritDoc} * {@inheritDoc}
*/ */
@Override
public void build() public void build()
{ {
PanelBuilder panelBuilder = new PanelBuilder().user(this.user).name( PanelBuilder panelBuilder = new PanelBuilder().user(this.user).name(

View File

@ -37,8 +37,12 @@ public class EditChallengeGUI extends CommonGUI
/** /**
* {@inheritDoc} * @param addon Addon where panel operates.
* @param challenge challenge that needs editing. * @param world World from which panel was created.
* @param user User who created panel.
* @param topLabel Command top label which creates panel (f.e. island or ai)
* @param permissionPrefix Command permission prefix (f.e. bskyblock.)
* @param challenge - challenge that needs editing
*/ */
public EditChallengeGUI(ChallengesAddon addon, public EditChallengeGUI(ChallengesAddon addon,
World world, World world,
@ -52,7 +56,11 @@ public class EditChallengeGUI extends CommonGUI
/** /**
* {@inheritDoc} * @param addon Addon where panel operates.
* @param world World from which panel was created.
* @param user User who created panel.
* @param topLabel Command top label which creates panel (f.e. island or ai)
* @param permissionPrefix Command permission prefix (f.e. bskyblock.)
* @param challenge challenge that needs editing. * @param challenge challenge that needs editing.
*/ */
public EditChallengeGUI(ChallengesAddon addon, public EditChallengeGUI(ChallengesAddon addon,

View File

@ -1,13 +1,17 @@
package world.bentobox.challenges.panel.admin; package world.bentobox.challenges.panel.admin;
import java.util.ArrayList;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
import org.bukkit.ChatColor; import org.bukkit.ChatColor;
import org.bukkit.Material; import org.bukkit.Material;
import org.bukkit.World; import org.bukkit.World;
import org.bukkit.enchantments.Enchantment;
import org.bukkit.inventory.ItemStack; import org.bukkit.inventory.ItemStack;
import java.util.*;
import java.util.stream.Collectors;
import net.wesjd.anvilgui.AnvilGUI; import net.wesjd.anvilgui.AnvilGUI;
import world.bentobox.bentobox.api.panels.PanelItem; import world.bentobox.bentobox.api.panels.PanelItem;
@ -38,7 +42,11 @@ public class EditLevelGUI extends CommonGUI
/** /**
* {@inheritDoc} * @param addon Addon where panel operates.
* @param world World from which panel was created.
* @param user User who created panel.
* @param topLabel Command top label which creates panel (f.e. island or ai)
* @param permissionPrefix Command permission prefix (f.e. bskyblock.)
* @param challengeLevel ChallengeLevel that must be edited. * @param challengeLevel ChallengeLevel that must be edited.
*/ */
public EditLevelGUI(ChallengesAddon addon, public EditLevelGUI(ChallengesAddon addon,
@ -53,7 +61,11 @@ public class EditLevelGUI extends CommonGUI
/** /**
* {@inheritDoc} * @param addon Addon where panel operates.
* @param world World from which panel was created.
* @param user User who created panel.
* @param topLabel Command top label which creates panel (f.e. island or ai)
* @param permissionPrefix Command permission prefix (f.e. bskyblock.)
* @param challengeLevel ChallengeLevel that must be edited. * @param challengeLevel ChallengeLevel that must be edited.
*/ */
public EditLevelGUI(ChallengesAddon addon, public EditLevelGUI(ChallengesAddon addon,

View File

@ -1,13 +1,13 @@
package world.bentobox.challenges.panel.admin; package world.bentobox.challenges.panel.admin;
import java.util.ArrayList;
import java.util.List;
import org.bukkit.Material; import org.bukkit.Material;
import org.bukkit.World; import org.bukkit.World;
import org.bukkit.inventory.ItemStack; import org.bukkit.inventory.ItemStack;
import java.util.ArrayList;
import java.util.List;
import net.wesjd.anvilgui.AnvilGUI; import net.wesjd.anvilgui.AnvilGUI;
import world.bentobox.bentobox.api.panels.PanelItem; import world.bentobox.bentobox.api.panels.PanelItem;
import world.bentobox.bentobox.api.panels.builders.PanelBuilder; import world.bentobox.bentobox.api.panels.builders.PanelBuilder;
@ -32,7 +32,11 @@ public class EditSettingsGUI extends CommonGUI
/** /**
* {@inheritDoc} * @param addon Addon where panel operates.
* @param world World from which panel was created.
* @param user User who created panel.
* @param topLabel Command top label which creates panel (f.e. island or ai)
* @param permissionPrefix Command permission prefix (f.e. bskyblock.)
*/ */
public EditSettingsGUI(ChallengesAddon addon, public EditSettingsGUI(ChallengesAddon addon,
World world, World world,
@ -45,7 +49,11 @@ public class EditSettingsGUI extends CommonGUI
/** /**
* {@inheritDoc} * @param addon Addon where panel operates.
* @param world World from which panel was created.
* @param user User who created panel.
* @param topLabel Command top label which creates panel (f.e. island or ai)
* @param permissionPrefix Command permission prefix (f.e. bskyblock.)
*/ */
public EditSettingsGUI(ChallengesAddon addon, public EditSettingsGUI(ChallengesAddon addon,
World world, World world,
@ -116,6 +124,7 @@ public class EditSettingsGUI extends CommonGUI
} }
@SuppressWarnings("deprecation")
private PanelItem getSettingsButton(Button button) private PanelItem getSettingsButton(Button button)
{ {
ItemStack icon; ItemStack icon;

View File

@ -29,7 +29,11 @@ public class ListChallengesGUI extends CommonGUI
/** /**
* {@inheritDoc} * @param addon Addon where panel operates.
* @param world World from which panel was created.
* @param user User who created panel.
* @param topLabel Command top label which creates panel (f.e. island or ai)
* @param permissionPrefix Command permission prefix (f.e. bskyblock.)
* @param mode - mode that indicate what should do icon clicking. * @param mode - mode that indicate what should do icon clicking.
*/ */
public ListChallengesGUI(ChallengesAddon addon, public ListChallengesGUI(ChallengesAddon addon,
@ -44,7 +48,11 @@ public class ListChallengesGUI extends CommonGUI
/** /**
* {@inheritDoc} * @param addon Addon where panel operates.
* @param world World from which panel was created.
* @param user User who created panel.
* @param topLabel Command top label which creates panel (f.e. island or ai)
* @param permissionPrefix Command permission prefix (f.e. bskyblock.)
* @param mode - mode that indicate what should do icon clicking. * @param mode - mode that indicate what should do icon clicking.
*/ */
public ListChallengesGUI(ChallengesAddon addon, public ListChallengesGUI(ChallengesAddon addon,

View File

@ -29,7 +29,11 @@ public class ListLevelsGUI extends CommonGUI
/** /**
* {@inheritDoc} * @param addon Addon where panel operates.
* @param world World from which panel was created.
* @param user User who created panel.
* @param topLabel Command top label which creates panel (f.e. island or ai)
* @param permissionPrefix Command permission prefix (f.e. bskyblock.)
* @param mode - mode that indicate what should do icon clicking. * @param mode - mode that indicate what should do icon clicking.
*/ */
public ListLevelsGUI(ChallengesAddon addon, public ListLevelsGUI(ChallengesAddon addon,
@ -44,7 +48,11 @@ public class ListLevelsGUI extends CommonGUI
/** /**
* {@inheritDoc} * @param addon Addon where panel operates.
* @param world World from which panel was created.
* @param user User who created panel.
* @param topLabel Command top label which creates panel (f.e. island or ai)
* @param permissionPrefix Command permission prefix (f.e. bskyblock.)
* @param mode - mode that indicate what should do icon clicking. * @param mode - mode that indicate what should do icon clicking.
*/ */
public ListLevelsGUI(ChallengesAddon addon, public ListLevelsGUI(ChallengesAddon addon,

View File

@ -76,7 +76,11 @@ public class ListUsersGUI extends CommonGUI
/** /**
* {@inheritDoc} * @param addon Addon where panel operates.
* @param world World from which panel was created.
* @param user User who created panel.
* @param topLabel Command top label which creates panel (f.e. island or ai)
* @param permissionPrefix Command permission prefix (f.e. bskyblock.)
* @param operationMode Indicate what should happen on player icon click. * @param operationMode Indicate what should happen on player icon click.
*/ */
public ListUsersGUI(ChallengesAddon addon, public ListUsersGUI(ChallengesAddon addon,
@ -91,7 +95,11 @@ public class ListUsersGUI extends CommonGUI
/** /**
* {@inheritDoc} * @param addon Addon where panel operates.
* @param world World from which panel was created.
* @param user User who created panel.
* @param topLabel Command top label which creates panel (f.e. island or ai)
* @param permissionPrefix Command permission prefix (f.e. bskyblock.)
* @param operationMode Indicate what should happen on player icon click. * @param operationMode Indicate what should happen on player icon click.
*/ */
public ListUsersGUI(ChallengesAddon addon, public ListUsersGUI(ChallengesAddon addon,