io.micronaut.guice.annotation.Guice Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of micronaut-guice-annotation Show documentation
Allows Importing Guice Modules
The newest version!
/*
 * Copyright 2017-2024 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.guice.annotation;

import com.google.inject.Module;
import io.micronaut.context.annotation.AliasFor;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Annotation that can be applied to the application entry point
 * that allows the import of Guice modules.
 *
 * Micronaut will import the modules and run them at startup when the application starts
 * registering the provided beans using the Guice DSL.
 *
 * Note all features of Guice are supported, there exist the following limitations:
 *
 * 
 *     Guice Scopes are not supported
 *     Guice AOP/Interceptors are not supported
 *     Guice private modules are not supported
 *     Static Injection is not supported
 *     Guice TypeConverters are not supported (use {@link io.micronaut.core.convert.TypeConverter} instead.
 *     Guice Listeners are not supported (use {@link io.micronaut.context.event.BeanCreatedEventListener} instead.
 *     None of the {@code com.google.inject.spi} API is supported
 * 
 *
 * Note that if you create a runtime binding to a class with {@link com.google.inject.binder.LinkedBindingBuilder#to(Class)} that has no injection annotations you may need to import the bean first
 * to allow the bean to be instantiated without reflection. This can be done with {@link io.micronaut.context.annotation.Import}
 *
 * Otherwise it is recommended to as a minimum use the {@link jakarta.inject.Inject} annotation on the constructor to avoid this need.
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.SOURCE)
public @interface Guice {
    /**
     * Import the given Guice modules.
     *
     * The modules are imported in the order defined by the array.
     *
     * @return An array of module types
     */
    Class[] modules();

    /**
     * Import the given Guice classes.
     *
     * @return An array of classes to import
     */
    Class[] classes() default {};

    /**
     * Import the given named Guice classes.
     *
     * @return An array of class names to import
     */
    @AliasFor(member = "classes")
    String[] classNames() default {};

    /**
     * Import the given packages as guice classes.
     * @return An array of package names
     */
    String[] packages() default {};

    /**
     * The environment where the modules should be active (Defaults to all environments).
     *
     * @return The environments.
     */
    String[] environments() default {};
}