Annotate all the things

This commit is contained in:
FalsePattern committed 2022-08-06 13:12:55 +02:00
1 parent 980e8a8776
commit da1ef6c8c7
63 files changed
+623 -369

No files matched your search

@@ -21,8 +21,10 @@
package com.falsepattern.lib;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Anything annotated with this annotation will be considered stable, and the class/method/field will not get breaking
@@ -31,17 +33,55 @@ import java.lang.annotation.RetentionPolicy;
* If a class or method is NOT annotated with this annotation, it will be considered unstable, and the package/method
* arguments/etc. can freely change between patch releases without notice.
* <p>
* If you have a class implementing another class, you don't need to annotate the {@link Override}-annotated methods with
* StableAPI, because the StableAPI system conforms to inheritance. You should still annotate the class itself, or any extra
* fields or non-override methods you may have added if you want to expose those too.
* <p>
* NOTICE: You should no longer use this annotation exclusively on classes themselves, and instead, annotate every single
* public or protected member you want to expose as a public API!
* <p>
* Private members will never be considered stable, and can be removed without notice.
* <p>
* You may set the {@link #since()} attribute to "__INTERNAL__", this will signal that even though the specific class/member
* has been marked as stable, it is still for internal use only. This may be done for reference purposes in multi-developer
* projects, where you need to communicate intent even in internal code.
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(value = {ElementType.TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.CONSTRUCTOR})
@StableAPI(since = "0.6.0")
public @interface StableAPI {
/**
* The version this API was introduced/stabilized in. Used for library version tracking.
*/
@StableAPI(since = "0.6.0") String since();
/**
* You may use this annotation if you want a member to have an equal effective {@link #since()} value as its owner
* class.
* <p>
* Everything else from the {@link StableAPI} class still applies, this is only here for brevity's sake.
* Note that if you add a new field in a version newer than the class, you must use {@link StableAPI} with the
* correct version!
* <p>
* Also note that this only works for class members (methods and fields),
* inner classes still need to use {@link StableAPI}.
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(value = {ElementType.FIELD, ElementType.METHOD, ElementType.CONSTRUCTOR})
@StableAPI(since = "0.10.0")
@interface Expose {}
/**
* Use this if you want to explicitly mark specific members of a {@link StableAPI} class as internal-use only.
* <p>
* Library consumers should never use class members marked with this annotation, as said members can be freely
* changed or removed in any version in the library without prior notice.
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(value = {ElementType.FIELD, ElementType.METHOD, ElementType.CONSTRUCTOR})
@StableAPI(since = "0.10.0")
@interface Internal {}
}