org.osgl.inject.Injector Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of genie Show documentation
A JSR330 style dependency injection solution
There is a newer version: 1.13.2
package org.osgl.inject;

/*-
 * #%L
 * OSGL Genie
 * %%
 * Copyright (C) 2017 OSGL (Open Source General Library)
 * %%
 * 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.
 * #L%
 */

import java.lang.annotation.Annotation;
import javax.inject.Provider;

/**
 * A generic Injector interface defines the contract
 * a dependency injector like {@link Genie} should provide.
 */
public interface Injector {
    /**
     * Returns a bean of given type.
     *
     * @param type
     *      the class of the bean
     * @param 
     *      generic type of the bean
     * @return
     *      the bean
     */
     T get(Class type);

    /**
     * Returns a provider of given type.
     *
     * @param type
     *      the class of the bean that provider provides
     * @param 
     *      the generic type of the bean
     * @return
     *      the provider that provides the bean
     */
     Provider getProvider(Class type);

    /**
     * Check if a supplied annotation class is a {@link javax.inject.Qualifier}.
     *
     * @param annoClass
     *      the annotation type
     * @return
     *      `true` if the annotation type is a qualifier or `false` otherwise
     */
    boolean isQualifier(Class annoClass);

    /**
     * Check if a supplied annotation class specifies a {@link PostConstructProcessor}.
     *
     * @param annoClass
     *      the annotation type
     * @return
     *      `true` if the annotation type specifies post construct processor
     */
    boolean isPostConstructProcessor(Class annoClass);

    /**
     * Check if a supplied annotation class is a {@link javax.inject.Scope} annotation.
     *
     * @param annoClass
     *      the annotation type
     * @return `true`
     *      if the annotation type indicate a scope
     */
    boolean isScope(Class annoClass);

    /**
     * Check if a supplied annotation class is a {@link org.osgl.inject.annotation.StopInheritedScope} annotation or alias of that annotation.
     *
     * @param annoClass
     *      the annotation type
     * @return
     *      `true` if the annotation type is inherited scope stopper
     */
    boolean isInheritedScopeStopper(Class annoClass);

    /**
     * Returns the scope annotation type from an alias annotation type.
     *
     * @param alias
     *      the alias of the scope annotation
     * @return
     *      the scope annotation type if found
     */
    Class scopeByAlias(Class alias);
}