Package io.fluxcapacitor.javaclient.tracking.handling

Class RequestAnnotationProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

io.fluxcapacitor.javaclient.tracking.handling.RequestAnnotationProcessor

All Implemented Interfaces:

Processor

@SupportedAnnotationTypes({"io.fluxcapacitor.javaclient.tracking.handling.HandleQuery","io.fluxcapacitor.javaclient.tracking.handling.HandleCommand","io.fluxcapacitor.javaclient.tracking.handling.HandleCustom"})
@AutoService(javax.annotation.processing.Processor.class)
public class RequestAnnotationProcessor
extends AbstractProcessor

Annotation processor that validates whether handler methods annotated with HandleCommand, HandleQuery or HandleCustom correctly match the response type declared by a Request payload.

The processor enforces compile-time consistency between:

• The generic type R in Request<R>
• The actual return type of the handler method (or Future<R>)

Validation Rules

• If a handler method accepts a Request<R> as a parameter, its return type must match R
• Asynchronous handlers that return Future<R> are also supported
• Handlers marked as passive=true are skipped
• Errors are reported at compile time with descriptive messages

Example

 @HandleQuery
 UserProfile handle(GetUser query) {
     return FluxCapacitor.search(UserProfile.class).match(query.getUserId()).fetchFirstOrNull();
 }
 

If the method were to return e.g. String instead of UserProfile, a compile-time error would be raised.

Supported Annotations

• HandleCommand
• HandleQuery
• HandleCustom

This processor is automatically registered via @AutoService(Processor.class) and does not require manual configuration.

Field Summary

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor	Description
RequestAnnotationProcessor()

Method Summary

Modifier and Type	Method	Description
SourceVersion	getSupportedSourceVersion()
boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)
protected void	validateMethod(Element method, TypeMirror requestType)
protected void	validateReturnType(Element method, TypeMirror payloadType, TypeMirror requestType)

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, getSupportedAnnotationTypes, getSupportedOptions, init, isInitialized

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RequestAnnotationProcessor

public RequestAnnotationProcessor()

Method Details

process

public boolean process(Set<? extends TypeElement> annotations,
 RoundEnvironment roundEnv)

Specified by:

process in interface Processor

Specified by:

process in class AbstractProcessor

validateMethod

protected void validateMethod(Element method,
 TypeMirror requestType)

validateReturnType

protected void validateReturnType(Element method,
 TypeMirror payloadType,
 TypeMirror requestType)

getSupportedSourceVersion

public SourceVersion getSupportedSourceVersion()

Specified by:

getSupportedSourceVersion in interface Processor

Overrides:

getSupportedSourceVersion in class AbstractProcessor