io.micronaut.data.annotation.RepositoryConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of micronaut-data-model Show documentation
Data Repository Support for Micronaut
There is a newer version: 4.10.3
/*
 * Copyright 2017-2020 original authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.micronaut.data.annotation;

import io.micronaut.data.model.Page;
import io.micronaut.data.model.Pageable;
import io.micronaut.data.model.Slice;
import io.micronaut.data.model.Sort;
import io.micronaut.data.model.query.builder.QueryBuilder;
import io.micronaut.data.model.query.builder.jpa.JpaQueryBuilder;
import io.micronaut.data.operations.RepositoryOperations;
import java.lang.annotation.*;

/**
 * Models compilation time configuration for the repository. Typically used as a meta-annotation.
 *
 * @author graemerocher
 * @since 1.0.0
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.ANNOTATION_TYPE, ElementType.TYPE})
@Documented
public @interface RepositoryConfiguration {

    /**
     * The builder to use to encode queries. Defaults to JPA-QL.
     *
     * @return The query builder
     */
    Class queryBuilder() default JpaQueryBuilder.class;

    /**
     * @return The default back end interface to use.
     */
    Class operations() default RepositoryOperations.class;

    /**
     * Configures {@link TypeRole} behaviour for a repository. This member allows for configuration of
     * custom types that play different roles in the construction and execution of repositories. Note that
     * additional {@link io.micronaut.core.convert.TypeConverter} instances may need to be registered if types
     * that do not extend from the defaults are registered.
     *
     * @return The parameter roles
     */
    TypeRole[] typeRoles() default {
            @TypeRole(role = TypeRole.PAGEABLE, type = Pageable.class),
            @TypeRole(role = TypeRole.SORT, type = Sort.class),
            @TypeRole(role = TypeRole.SLICE, type = Slice.class),
            @TypeRole(role = TypeRole.PAGE, type = Page.class)
    };

    /**
     * Does the repository allow implicit queries by type and ID etc. or are explicit query always needed.
     *
     * @return True if it does
     */
    boolean implicitQueries() default true;

    /**
     * Whether named parameters starting with colon are supported in the query syntax.
     * @return True if named parameters are supported
     */
    boolean namedParameters() default true;

    /**
     * Custom data-transfer types that this repository supports.
     * @return The DTO types
     * @since 4.0.0
     */
    Class[] queryDtoTypes() default {};

    /**
     * Custom find interceptors definition.
     * @return The interceptor definitions.
     * @since 4.0.0
     */
    FindInterceptorDef[] findInterceptors() default {};

}