From 2ed120534149c13d3faf5d095aa9a7fc77171abd Mon Sep 17 00:00:00 2001 From: Aram Date: Thu, 19 Sep 2024 10:44:41 +0200 Subject: [PATCH] Update ParameterBase.java * Fixed all Comments --- .../entity/variant/base/ParameterBase.java | 86 +++++++++---------- 1 file changed, 43 insertions(+), 43 deletions(-) diff --git a/NeoForge/src/main/java/software/bluelib/entity/variant/base/ParameterBase.java b/NeoForge/src/main/java/software/bluelib/entity/variant/base/ParameterBase.java index 0cbf374e..37fe902d 100644 --- a/NeoForge/src/main/java/software/bluelib/entity/variant/base/ParameterBase.java +++ b/NeoForge/src/main/java/software/bluelib/entity/variant/base/ParameterBase.java @@ -10,23 +10,23 @@ import java.util.Set; /** - * An abstract base class for managing a collection of parameters. + * An {@code public abstract base class} for managing a collection of {@link #parameters}. *

- * This class provides methods to add, retrieve, remove, and manipulate parameters stored as key-value pairs. + * This {@code class} provides methods to add, retrieve, remove, and manipulate {@link #parameters} stored as key-value pairs. *

* Key Methods: * * @author MeAlam * @Co-author Dan @@ -35,9 +35,9 @@ public abstract class ParameterBase { /** - * A {@link Map} to store parameters as key-value pairs. + * A {@code private final} {@link Map} to store parameters as key-value pairs. *

- * This map holds parameter keys and their corresponding values. + * This {@link Map} holds parameter keys and their corresponding values. *

* @Co-author MeAlam, Dan * @since 1.0.0 @@ -45,9 +45,9 @@ public abstract class ParameterBase { private final Map parameters = new HashMap<>(); /** - * A {@code void} that adds a parameter to the collection. + * A {@code protected void} that adds a parameter to {@link #parameters}. *

- * This method stores a new parameter with the specified key and value in the internal map. + * This method stores a new parameter with the specified key and value in {@link #parameters}. *

* @param pKey {@link String} - The key under which the parameter is stored. * @param pValue {@link Object} - The value of the parameter. @@ -61,12 +61,12 @@ protected void addParameter(String pKey, Object pValue) { } /** - * A {@link Object} that retrieves a parameter from the collection by its key. + * A {@code protected} {@link Object} that retrieves a parameter from {@link #parameters} by its key. *

* This method returns the value associated with the specified key, or {@code null} if the key does not exist. *

* @param pKey {@link String} - The key of the parameter to retrieve. - * @return The value associated with the key, or {@code null} if the key does not exist. + * @return {@link Object} - The value associated with the key, or {@code null} if the key does not exist. * @author MeAlam * @Co-author Dan * @since 1.0.0 @@ -78,9 +78,9 @@ protected Object getParameter(String pKey) { } /** - * A {@code void} that removes a parameter from the collection by its key. + * A {@code protected void} that removes a parameter from {@link #parameters} by its key. *

- * This method deletes the parameter with the specified key from the internal map. If the key does not exist, no action is taken. + * This method deletes the parameter with the specified key from {@link #parameters}. If the key does not exist, no action is taken. *

* @param pKey {@link String} - The key of the parameter to remove. * @author MeAlam @@ -96,11 +96,11 @@ protected void removeParameter(String pKey) { } /** - * A {@link Map} that returns all parameters in the collection. + * A {@code protected} {@link Map} that returns all parameters in {@link #parameters}. *

- * This method returns a new {@link Map} containing all parameters stored in the internal map. + * This method returns a new {@link Map} containing all parameters stored in {@link #parameters}. *

- * @return A {@link Map} containing all parameters. + * @return {@link Map} - A {@link Map} containing all parameters. * @author MeAlam * @Co-author Dan * @since 1.0.0 @@ -111,12 +111,12 @@ protected Map getAllParameters() { } /** - * A {@link Boolean} that checks if a parameter exists by its key. + * A {@code protected} {@link Boolean} that checks if a parameter exists by its key. *

- * This method returns {@code true} if the parameter with the specified key exists in the collection, {@code false} otherwise. + * This method returns {@code true} if the parameter with the specified key exists in {@link #parameters}, {@code false} otherwise. *

* @param pKey {@link String} - The key of the parameter to check. - * @return {@code true} if the parameter exists, {@code false} otherwise. + * @return {@link Boolean} - {@code true} if the parameter exists, {@code false} otherwise. * @author MeAlam * @Co-author Dan * @since 1.0.0 @@ -128,11 +128,11 @@ protected boolean containsParameter(String pKey) { } /** - * A {@link Boolean} that checks if the collection of parameters is empty. + * A {@code protected} {@link Boolean} that checks if {@link #parameters} is empty. *

- * This method returns {@code true} if the collection contains no parameters, {@code false} otherwise. + * This method returns {@code true} if {@link #parameters} contains no parameters, {@code false} otherwise. *

- * @return {@code true} if the collection is empty, {@code false} otherwise. + * @return {@link Boolean} - {@code true} if {@link #parameters} is empty, {@code false} otherwise. * @author MeAlam * @Co-author Dan * @since 1.0.0 @@ -144,9 +144,9 @@ protected boolean isEmpty() { } /** - * A {@code void} that clears all parameters from the collection. + * A {@code protected void} that clears all parameters from {@link #parameters}. *

- * This method removes all parameters from the internal map. + * This method removes all parameters from {@link #parameters}. *

* @author MeAlam * @Co-author Dan @@ -158,11 +158,11 @@ protected void clearParameters() { } /** - * A {@link Integer} that returns the number of parameters in the collection. + * A {@code protected} {@link Integer} that returns the number of parameters in {@link #parameters}. *

- * This method provides the count of parameters currently stored in the internal map. + * This method provides the count of parameters currently stored in {@link #parameters}. *

- * @return The number of parameters in the collection. + * @return {@link Integer} - The number of parameters in the collection. * @author MeAlam * @Co-author Dan * @since 1.0.0 @@ -174,11 +174,11 @@ protected int getParameterCount() { } /** - * A {@link Set} that returns a set of all parameter keys. + * A {@code protected} {@link Set} that returns a set of all parameter keys. *

- * This method provides a {@link Set} containing all the keys of parameters in the collection. + * This method provides a {@link Set} containing all the keys of parameters in {@link #parameters}. *

- * @return A {@link Set} containing all parameter keys. + * @return {@link Set} - A {@link Set} containing all parameter keys. * @author MeAlam * @Co-author Dan * @since 1.0.0 @@ -189,11 +189,11 @@ protected Set getParameterKeys() { } /** - * A {@link Collection} that returns a collection of all parameter values. + * A {@code protected} {@link Collection} that returns a {@link Collection} of all parameter values. *

- * This method provides a {@link Collection} containing all the values of parameters in the collection. + * This method provides a {@link Collection} containing all the values of parameters in {@link #parameters}. *

- * @return A {@link Collection} containing all parameter values. + * @return {@link Collection} - A {@link Collection} containing all parameter values. * @author MeAlam * @Co-author Dan * @since 1.0.0 @@ -204,9 +204,9 @@ protected Collection getParameterValues() { } /** - * A {@code void} that updates the value of an existing parameter. + * A {@code protected void} that updates the value of an existing parameter. *

- * This method changes the value of a parameter identified by the specified key. If the key does not exist, an exception is thrown. + * This method changes the value of a parameter in {@link #parameters} that is identified by the specified key. If the key does not exist, an exception is thrown. *

* @param pKey {@link String} - The key of the parameter to update. * @param pNewValue {@link Object} - The new value to set for the parameter.