Skip to content

Commit

Permalink
Update ParameterBase.java
Browse files Browse the repository at this point in the history
* Cleared up some comments

Co-Authored-By: Justindraak1 <[email protected]>
  • Loading branch information
MeAlam1 and Justindraak1 committed Oct 6, 2024
1 parent 9eff5e2 commit db425c6
Showing 1 changed file with 4 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
import java.util.Set;

/**
* An {@code public abstract base class} for managing a collection of {@link #parameters}.
* A {@code public abstract base class} for managing a collection of {@link #parameters}.
* <p>
* This {@code class} provides methods to add, retrieve, remove, and manipulate {@link #parameters} stored as key-value pairs.
* </p>
Expand Down Expand Up @@ -117,7 +117,7 @@ protected Map<String, Object> getAllParameters() {
* This method returns {@code true} if the parameter with the specified key exists in {@link #parameters}, {@code false} otherwise.
* </p>
* @param pKey {@link String} - The key of the parameter to check.
* @return {@link Boolean} - {@code true} if the parameter exists, {@code false} otherwise.
* @return {@link Boolean} - {@code true} if the parameter exists and {@code false} if it doesn't.
* @author MeAlam
* @Co-author Dan
* @since 1.0.0
Expand All @@ -133,7 +133,7 @@ protected boolean containsParameter(String pKey) {
* <p>
* This method returns {@code true} if {@link #parameters} contains no parameters, {@code false} otherwise.
* </p>
* @return {@link Boolean} - {@code true} if {@link #parameters} is empty, {@code false} otherwise.
* @return {@link Boolean} - {@code true} if {@link #parameters} is empty and {@code false} if it isn't.
* @author MeAlam
* @Co-author Dan
* @since 1.0.0
Expand All @@ -145,10 +145,7 @@ protected boolean isEmpty() {
}

/**
* A {@code protected void} that clears all parameters from {@link #parameters}.
* <p>
* This method removes all parameters from {@link #parameters}.
* </p>
* A {@code protected void} that removes all parameters from {@link #parameters}.
* @author MeAlam
* @Co-author Dan
* @since 1.0.0
Expand All @@ -160,9 +157,6 @@ protected void clearParameters() {

/**
* A {@code protected} {@link Integer} that returns the number of parameters in {@link #parameters}.
* <p>
* This method provides the count of parameters currently stored in {@link #parameters}.
* </p>
* @return {@link Integer} - The number of parameters in the collection.
* @author MeAlam
* @Co-author Dan
Expand Down

0 comments on commit db425c6

Please sign in to comment.