Add @since tags

Author: NonSwag

plugin/src/main/java/net/milkbowl/vault/Vault.java

@@ -6,6 +6,8 @@
 /**
  * A compatibility class used to mitigate issues caused by certain plugins that check the instance
  * of the plugin for validation, potentially leading to class not found errors.
+ *
+ * @since 2.2.1
  */
 @ApiStatus.Internal
 public class Vault extends JavaPlugin {

plugin/src/main/java/net/thenextlvl/service/plugin/placeholder/economy/UnlockedEconomyPlaceholderStore.java

@@ -10,6 +10,8 @@
 
 /**
  * <a href="https://github.com/TheNewEconomy/VaultUnlocked/blob/master/src/net/milkbowl/vault/papi/EconomyPlaceholders.java">Source</a>
+ *
+ * @since 2.6.1
  */
 public final class UnlockedEconomyPlaceholderStore extends PlaceholderStore<Economy> {
     private static final String PLUGIN_NAME = "VaultUnlocked";

src/main/java/net/thenextlvl/service/Controller.java

@@ -8,6 +8,7 @@ public interface Controller {
      * Retrieves the plugin associated with the controller.
      *
      * @return the plugin instance linked to the controller.
+     * @since 2.2.1
      */
     @Contract(pure = true)
     Plugin getPlugin();
@@ -16,6 +17,7 @@ public interface Controller {
      * Retrieves the name associated with the controller.
      *
      * @return the name of the controller.
+     * @since 2.2.1
      */
     @Contract(pure = true)
     String getName();

src/main/java/net/thenextlvl/service/capability/Capability.java

@@ -9,6 +9,8 @@
  * <p>
  * Implementations of this interface can be used in conjunction with capability
  * providers or related systems to organize and query available functionalities.
+ *
+ * @since 2.2.0
  */
 @FunctionalInterface
 public interface Capability {

src/main/java/net/thenextlvl/service/capability/CapabilityException.java

@@ -6,6 +6,8 @@
  * An exception that indicates a problem related to a specific {@link Capability}.
  * This exception is typically thrown when there is an issue or unsupported operation
  * associated with a particular capability in the system.
+ *
+ * @since 2.2.0
  */
 public class CapabilityException extends RuntimeException {
     private final Capability capability;
@@ -29,6 +31,7 @@ public CapabilityException(final Plugin plugin, final Capability capability) {
      * @param message    the detail message, providing additional information about the exception.
      * @param capability the {@link Capability} instance associated with this exception,
      *                   indicating the capability that caused the issue.
+     * @since 3.0.0
      */
     public CapabilityException(final String message, final Capability capability) {
         super(message);
@@ -40,6 +43,7 @@ public CapabilityException(final String message, final Capability capability) {
      *
      * @return the {@link Capability} instance that caused this exception,
      * representing a specific feature or limitation.
+     * @since 2.2.0
      */
     public Capability getCapability() {
         return this.capability;

src/main/java/net/thenextlvl/service/capability/CapabilityProvider.java

@@ -12,12 +12,14 @@
  * capabilities and provides mechanisms to check whether the provider supports individual or multiple capabilities.
  *
  * @param <T> the type of {@link Capability} supported by this provider
+ * @since 2.2.0
  */
 public interface CapabilityProvider<T extends Capability> {
     /**
      * Retrieves an unmodifiable set of all available capabilities supported by the capability provider.
      *
      * @return an unmodifiable {@link Set} containing the supported {@link T capability} values
+     * @since 2.2.0
      */
     @Unmodifiable
     Set<T> getCapabilities();
@@ -27,6 +29,7 @@ public interface CapabilityProvider<T extends Capability> {
      *
      * @param capabilities the collection of {@link T capability} instances to verify for support
      * @return {@code true} if all the specified capabilities are supported; {@code false} otherwise
+     * @since 2.2.0
      */
     boolean hasCapabilities(Collection<T> capabilities);
 
@@ -35,6 +38,7 @@ public interface CapabilityProvider<T extends Capability> {
      *
      * @param capability the {@link T capability} to verify for support
      * @return {@code true} if the given capability is supported; {@code false} otherwise
+     * @since 2.2.0
      */
     boolean hasCapability(T capability);
 }

src/main/java/net/thenextlvl/service/character/Character.java

@@ -18,6 +18,8 @@
  * <p>
  * A character may or may not be backed by a real server entity, depending on
  * provider capabilities and spawn state.
+ *
+ * @since 2.2.0
  */
 public interface Character {
     /**
@@ -26,20 +28,23 @@ public interface Character {
      * @param location the {@code Location} to which the character will be teleported
      * @return a {@code CompletableFuture} that resolves to {@code true} if the teleportation was
      * successful, or {@code false} otherwise
+     * @since 2.2.0
      */
     CompletableFuture<Boolean> teleportAsync(Location location);
 
     /**
      * Retrieves the name of the character.
      *
      * @return the name of the character
+     * @since 3.0.0
      */
     String getName();
 
     /**
      * Checks if this character is persistent.
      *
      * @return {@code true} if this character is persistent, {@code false} otherwise
+     * @since 3.0.0
      */
     boolean isPersistent();
 
@@ -48,27 +53,31 @@ public interface Character {
      *
      * @param persistent {@code true} if this character should be persistent, {@code false} otherwise
      * @return {@code true} if the persistence was changed, {@code false} otherwise
+     * @since 3.0.0
      */
     boolean setPersistent(boolean persistent);
 
     /**
      * Persists this character.
      *
      * @return {@code true} if the character was persisted, {@code false} otherwise
+     * @since 3.0.0
      */
     boolean persist();
 
     /**
      * Retrieves the display name of the character.
      *
      * @return the {@code Component} representing the display name of the character
+     * @since 2.2.0
      */
     Component getDisplayName();
 
     /**
      * Retrieves the type of entity associated with the character.
      *
      * @return the entity type of the character
+     * @since 2.2.0
      */
     EntityType getType();
 
@@ -77,6 +86,7 @@ public interface Character {
      *
      * @return the current location, or an empty {@code Optional} if it is not
      * available
+     * @since 3.0.0
      */
     Optional<Location> getLocation();
 
@@ -85,6 +95,7 @@ public interface Character {
      *
      * @return the current world, or an empty {@code Optional} if it is not
      * available
+     * @since 3.0.0
      */
     Optional<World> getWorld();
 
@@ -98,13 +109,15 @@ public interface Character {
      *
      * @return an {@code Optional} containing the associated entity, or an empty {@code Optional}
      * if no entity is associated with the character
+     * @since 3.0.0
      */
     Optional<Entity> getEntity();
 
     /**
      * Retrieves an unmodifiable set of players currently tracking this character.
      *
      * @return the players currently tracking this character
+     * @since 3.0.0
      */
     @Unmodifiable
     Set<Player> getTrackedBy();
@@ -114,6 +127,7 @@ public interface Character {
      * of this character.
      *
      * @return the configured viewers of this character
+     * @since 3.0.0
      */
     @Unmodifiable
     Set<Player> getViewers();
@@ -123,6 +137,7 @@ public interface Character {
      *
      * @param player the player to add
      * @return {@code true} if the viewer was added, {@code false} otherwise
+     * @since 3.0.0
      */
     boolean addViewer(Player player);
 
@@ -131,6 +146,7 @@ public interface Character {
      *
      * @param players the players to add
      * @return {@code true} if any viewers were added, {@code false} otherwise
+     * @since 3.0.0
      */
     boolean addViewers(Collection<Player> players);
 
@@ -139,6 +155,7 @@ public interface Character {
      *
      * @param player the player to check
      * @return {@code true} if the player is tracking this character, {@code false} otherwise
+     * @since 3.0.0
      */
     boolean isTrackedBy(Player player);
 
@@ -148,13 +165,15 @@ public interface Character {
      * @param player the player to check
      * @return {@code true} if the player currently qualifies to see this
      * character, {@code false} otherwise
+     * @since 3.0.0
      */
     boolean canSee(Player player);
 
     /**
      * Checks if this character is visible by default.
      *
      * @return {@code true} if this character is visible by default, {@code false} otherwise
+     * @since 3.0.0
      */
     boolean isVisibleByDefault();
 
@@ -163,6 +182,7 @@ public interface Character {
      *
      * @param player the player to remove
      * @return {@code true} if the viewer was removed, {@code false} otherwise
+     * @since 3.0.0
      */
     boolean removeViewer(Player player);
 
@@ -171,20 +191,23 @@ public interface Character {
      *
      * @param players the players to remove
      * @return {@code true} if any viewers were removed, {@code false} otherwise
+     * @since 3.0.0
      */
     boolean removeViewers(Collection<Player> players);
 
     /**
      * Retrieves the display range of this character.
      *
      * @return the display range
+     * @since 3.0.0
      */
     double getDisplayRange();
 
     /**
      * Sets the display range of this character.
      *
      * @param range the new display range
+     * @since 3.0.0
      */
     void setDisplayRange(double range);
 
@@ -193,48 +216,55 @@ public interface Character {
      *
      * @param visible {@code true} if this character should be visible by default, {@code false} otherwise
      * @return {@code true} if the visibility was changed, {@code false} otherwise
+     * @since 3.0.0
      */
     boolean setVisibleByDefault(boolean visible);
 
     /**
      * Despawns the character, effectively removing it from the world or rendering it inactive.
      *
      * @return {@code true} if the character was successfully despawned, otherwise {@code false}
+     * @since 2.2.0
      */
     boolean despawn();
 
     /**
      * Checks if the character is collidable, meaning it can interact physically with other entities.
      *
      * @return {@code true} if the character is collidable, otherwise {@code false}
+     * @since 2.2.0
      */
     boolean isCollidable();
 
     /**
      * Checks if the character is invulnerable.
      *
      * @return {@code true} if the character is invulnerable, otherwise {@code false}
+     * @since 2.2.0
      */
     boolean isInvulnerable();
 
     /**
      * Checks if the character is currently spawned in the world.
      *
      * @return {@code true} if the character is spawned, otherwise {@code false}
+     * @since 2.2.0
      */
     boolean isSpawned();
 
     /**
      * Checks whether the tablist entry for the character is currently hidden.
      *
      * @return {@code true} if the tablist entry is hidden, otherwise {@code false}
+     * @since 2.2.0
      */
     boolean isTablistEntryHidden();
 
     /**
      * Respawns the character, bringing it back to the world if it was previously despawned.
      *
      * @return {@code true} if the character was successfully respawned, otherwise {@code false}
+     * @since 2.2.0
      */
     boolean respawn();
 
@@ -243,26 +273,31 @@ public interface Character {
      *
      * @param location the {@code Location} where the character will be spawned
      * @return {@code true} if the character was successfully spawned, otherwise {@code false}
+     * @since 2.2.0
      */
     boolean spawn(Location location);
 
     /**
      * Adjusts the character's orientation to face the given entity.
      *
      * @param entity the {@code Entity} that the character should face
+     * @since 2.2.0
      */
     void lookAt(Entity entity);
 
     /**
      * Adjusts the character's orientation to face the specified location.
      *
      * @param location the {@code Location} that the character should face
+     * @since 2.2.0
      */
     void lookAt(Location location);
 
     /**
      * Permanently removes the character, rendering it inaccessible and removing all associated data.
      * After invoking this method, the character can't be respawned or interacted with.
+     *
+     * @since 2.2.0
      */
     void remove();
 
@@ -271,27 +306,31 @@ public interface Character {
      * with other entities in the world.
      *
      * @param collidable {@code true} to make the character collidable, allowing physical interactions
+     * @since 2.2.0
      */
     void setCollidable(boolean collidable);
 
     /**
      * Sets the display name for the character.
      *
      * @param displayName the {@code Component} representing the new display name to be set
+     * @since 2.2.0
      */
     void setDisplayName(Component displayName);
 
     /**
      * Sets whether the character should be invulnerable.
      *
      * @param invulnerable {@code true} if the character should be invulnerable, {@code false} otherwise
+     * @since 2.2.0
      */
     void setInvulnerable(boolean invulnerable);
 
     /**
      * Sets the visibility state of the character's tablist entry.
      *
      * @param hidden {@code true} to hide the tablist entry, {@code false} to make it visible
+     * @since 2.2.0
      */
     void setTablistEntryHidden(boolean hidden);
 }