Package tech.guilhermekaua.spigotboot.core.context.discovery

Annotation Interface SpigotBootDiscoveryCategory

@Retention(CLASS)
@Target(TYPE)
public @interface SpigotBootDiscoveryCategory

Marks an annotation or type as the root of a DiscoveryIndex category. Downstream modules apply this meta-annotation to their own annotations or supertypes to extend discovery without modifying the annotation processor.

Example: classify anything implementing a community module's repository interface.

 @SpigotBootDiscoveryCategory(value = "my-plugin.repository", kind = Kind.SUBTYPE)
 public interface CommunityRepository<T, ID> { ... }
 

Example: classify anything annotated with a custom stereotype.

 @SpigotBootDiscoveryCategory(value = "my-plugin.handler", kind = Kind.ANNOTATION)
 public @interface MyHandler { }
 

At runtime, query the reader with the same category name:

 reader.classesInCategory("my-plugin.repository", basePackage);
 

RetentionPolicy.CLASS retention is used so the annotation processor can read this meta-annotation from compiled dependency jars, but the runtime doesn't pay the cost of loading it into reflective metadata.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SpigotBootDiscoveryCategory.Kind

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
SpigotBootDiscoveryCategory.Kind	kind
String	value

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	transitive	For SpigotBootDiscoveryCategory.Kind.ANNOTATION rules: when true, classes annotated with any annotation that is (transitively) meta-annotated with the category-bearing annotation also match — mirroring the classic Spring @Component/@Service stereotype pattern.

Element Details

value

String value

Returns:

the category key used to register matching classes. Use a namespaced string (e.g. "my-plugin.repository") to avoid clashing with spigot-boot's built-in categories or other community modules.

kind

SpigotBootDiscoveryCategory.Kind kind

Returns:

whether this rule matches annotations on the target class (SpigotBootDiscoveryCategory.Kind.ANNOTATION) or supertypes of the target class (SpigotBootDiscoveryCategory.Kind.SUBTYPE).

transitive

boolean transitive

For SpigotBootDiscoveryCategory.Kind.ANNOTATION rules: when true, classes annotated with any annotation that is (transitively) meta-annotated with the category-bearing annotation also match — mirroring the classic Spring @Component/@Service stereotype pattern. Default false means only direct annotations trigger the rule.

Ignored for SpigotBootDiscoveryCategory.Kind.SUBTYPE rules (supertype walks are always transitive).

Returns:

true if transitive meta-annotation matching is enabled; false (default) for direct-annotation-only matching.

Default:

false