Skip to content

Commit 33c02e0

Browse files
committed
Added @since annotations across API interfaces
Documented the version in which interfaces, methods, and classes were introduced.
1 parent d0563b4 commit 33c02e0

35 files changed

+102
-8
lines changed

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44
import org.jetbrains.annotations.Contract;
55
import org.jspecify.annotations.NullMarked;
66

7+
/**
8+
* The `Controller` interface provides methods to retrieve basic information
9+
* about the controller, such as the associated plugin and name.
10+
*
11+
* @since 2.2.1
12+
*/
713
@NullMarked
814
public interface Controller {
915
/**

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@
1313
* <p>
1414
* Implementations of this interface can be used in conjunction with capability
1515
* providers or related systems to organize and query available functionalities.
16+
*
17+
* @since 2.2.0
1618
*/
1719
public interface Capability extends Keyed {
1820
}

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
* An exception that indicates a problem related to a specific {@link Capability}.
88
* This exception is typically thrown when there is an issue or unsupported operation
99
* associated with a particular capability in the system.
10+
*
11+
* @since 2.2.0
1012
*/
1113
@NullMarked
1214
public class CapabilityException extends RuntimeException {

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
* capabilities and provides mechanisms to check whether the provider supports individual or multiple capabilities.
1414
*
1515
* @param <T> the type of {@link Capability} supported by this provider
16+
* @since 2.2.0
1617
*/
1718
@NullMarked
1819
public interface CapabilityProvider<T extends Capability> {

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
* functionalities such as spawning, despawning, teleportation, and state management.
1919
*
2020
* @param <T> the type of the entity associated with this character
21+
* @since 2.2.0
2122
*/
2223
@NullMarked
2324
public interface Character<T extends Entity> extends Persistable, Viewable {

src/main/java/net/thenextlvl/service/api/character/CharacterCapability.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@
1818
* <p>
1919
* Each capability is associated with a unique {@link Key} that acts as an
2020
* identifier for the capability.
21+
*
22+
* @since 2.2.0
2123
*/
2224
@NullMarked
2325
public enum CharacterCapability implements Capability {

src/main/java/net/thenextlvl/service/api/character/CharacterController.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@
2121
* and interacting with non-player characters (NPCs).
2222
* It includes functionality for creating, spawning, retrieving, and checking
2323
* entities as NPCs, along with capability management.
24+
*
25+
* @since 2.2.0
2426
*/
2527
@NullMarked
2628
public interface CharacterController extends CapabilityProvider<CharacterCapability>, Controller {

src/main/java/net/thenextlvl/service/api/character/event/CharacterDamageEvent.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414
* the damage, and controlling whether the event should be cancelled.
1515
* <p>
1616
* This event will only be fired for providers that support the {@link CharacterCapability#HEALTH} capability.
17+
*
18+
* @since 2.2.0
1719
*/
1820
@NullMarked
1921
public class CharacterDamageEvent extends CharacterEvent implements Cancellable {

src/main/java/net/thenextlvl/service/api/character/event/CharacterEvent.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616
* <p>
1717
* Subclasses can make use of these common properties while implementing specific
1818
* character-related event functionalities.
19+
*
20+
* @since 2.2.0
1921
*/
2022
@NullMarked
2123
public abstract class CharacterEvent extends Event {

src/main/java/net/thenextlvl/service/api/character/event/EntityDamageCharacterEvent.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515
* It can be used to inspect and modify the damage attributed to an entity's attack and to check the critical status.
1616
* <p>
1717
* This event will only be fired for providers that support the {@link CharacterCapability#HEALTH} capability.
18+
*
19+
* @since 2.2.0
1820
*/
1921
@NullMarked
2022
public class EntityDamageCharacterEvent extends CharacterDamageEvent {

0 commit comments

Comments
 (0)