Package valorless.rarespawns.annotations

package valorless.rarespawns.annotations
Annotations used throughout RareSpawns to document API contracts and usage.

This package provides compile-time/documentation annotations such as:

  • NotNull and Nullable to declare nullability contracts.
  • DoNotCall to mark APIs that must not be invoked by plugins.
  • TestOnly to indicate elements intended only for testing.
  • MarkedForRemoval to flag elements scheduled for removal in a future release.
These annotations aid static analysis and improve generated documentation; they typically have no runtime effect unless explicitly processed.
  • Annotation Interfaces
    Class
    Description
    DoNotCall
    Indicates that a method or constructor is not intended to be called directly.
    MarkedForRemoval
    Marks a field, method, or constructor as slated for removal in a future release.
    NotNull
    Indicates that a method parameter must not be null.
    Nullable
    Indicates that a method parameter can accept null values.
    TestOnly
    Annotation indicating that the annotated element is intended for testing purposes only.