io.rxmicro.cdi.Named Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rxmicro-cdi Show documentation

The module that is an implementation of the Dependency Injection design pattern, that is integrated to the RxMicro framework.

The newest version!

/*
 * Copyright (c) 2020. https://rxmicro.io
 *
 * 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
 *
 *     http://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.rxmicro.cdi;

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

import static java.lang.annotation.ElementType.CONSTRUCTOR;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.CLASS;

/**
 * Allows customizing an injection point by specifying a string value or custom annotation.
 * This annotation can also be used to specify a component name.
 *
 * 
 * Is a synonym of the {@link Qualifier} annotation, and is recommended for developers who have used JEE or
 * Google Guice as CDI implementation in their previous projects.
 *
 * @author nedis
 * @see Qualifier
 * @see Inject
 * @since 0.1
 */
@Documented
@Retention(CLASS)
@Target({FIELD, TYPE, METHOD, CONSTRUCTOR, PARAMETER})
public @interface Named {

    /**
     * Returns the customized name of component or injection point.
     *
     * @return the customized name of component or injection point
     */
    String value();
}