io.micronaut.context.annotation.AliasFor 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

There is a newer version: 4.7.5

/*
 * 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.*;

/**
 * Allows specifying an annotation member alias. In other words, a value of an annotation member can be used to
 * represent the value of another annotation's member or a another member within the same annotation.
 *
 * The representation is constructed via the {@link io.micronaut.core.annotation.AnnotationMetadata} interface
 *
 * @author Graeme Rocher
 * @see io.micronaut.core.annotation.AnnotationMetadata
 * @since 1.0
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
@Documented
@Repeatable(Aliases.class)
public @interface AliasFor {

    /**
     * @return The name of the member that this member is an alias for
     */
    String member() default "";

    /**
     * @return The type of annotation in which the aliased {@link #member()} is declared.
     * If not specified the alias is applied to the current annotation.
     */
    Class annotation() default Annotation.class;

    /**
     * @return The name of the annotation in which the aliased {@link #member()} is declared.
     * If not specified the alias is applied to the current annotation.
     */
    String annotationName() default "";
}