com.github.rahulsom.grooves.groovy.transformations.Query Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of grooves-groovy Show documentation

Support for completeness of queries in Groovy code

There is a newer version: 0.8.0

package com.github.rahulsom.grooves.groovy.transformations;

import com.github.rahulsom.grooves.api.AggregateType;
import com.github.rahulsom.grooves.api.snapshots.Snapshot;
import com.github.rahulsom.grooves.groovy.transformations.internal.QueryASTTransformation;
import org.codehaus.groovy.transform.GroovyASTTransformationClass;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Marks a class as a Query.
 *
 * The query is something that computes a snapshot out of an aggregate and a collection of events
 *
 * @author Rahul Somasunderam
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.SOURCE)
@GroovyASTTransformationClass(classes = QueryASTTransformation.class)
public @interface Query {
    /**
     * The aggregate for which this query needs to be performed
     *
     * @return The aggregate for which this query needs to be performed
     */
    Class aggregate();

    /**
     * The snapshot that the query will return
     *
     * @return The snapshot that the query will return
     */
    Class snapshot();
}