io.micronaut.context.annotation.ConfigurationReader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of micronaut-inject Show documentation
Natively Cloud Native
The newest version!
/*
 * 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.context.annotation;

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

import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * A meta annotation for use with other annotations to indicate that the annotation reads configuration.
 *
 * @author Graeme Rocher
 * @see ConfigurationProperties
 * @since 1.0
 */
@Documented
@Retention(RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
@BeanProperties(accessKind = {BeanProperties.AccessKind.METHOD, BeanProperties.AccessKind.FIELD}, visibility = BeanProperties.Visibility.DEFAULT)
public @interface ConfigurationReader {

    /**
     * The prefix name.
     */
    String PREFIX = "prefix";

    /**
     * The base prefix name.
     */
    String BASE_PREFIX = "basePrefix";
    String PREFIX_CALCULATED = "prefixCalculated";

    /**
     * The prefix to use when resolving properties. The prefix should be defined in kebab case. Example: my-app.foo.
     *
     * @return The configuration entry to read
     */
    @AliasFor(member = PREFIX)
    String value() default "";

    /**
     * @return The prefix to use
     */
    String prefix() default "";

    /**
     * The base prefix to prepend to the original prefix.
     * @return The base prefix
     * @since 4.0.0
     */
    String basePrefix() default "";

    /**
     * @return The names of the properties to include
     */
    @AliasFor(annotation = BeanProperties.class, member = BeanProperties.MEMBER_INCLUDES)
    String[] includes() default {};

    /**
     * @return The names of the properties to exclude
     */
    @AliasFor(annotation = BeanProperties.class, member = BeanProperties.MEMBER_EXCLUDES)
    String[] excludes() default {};
}