/*
* 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 static java.lang.annotation.RetentionPolicy.RUNTIME;
import javax.inject.Singleton;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
This annotation allows driving the production of Bean
definitions from presence of other bean definitions. Typically used in conjunction with EachProperty
For example:
@EachProperty("foo.bar") public class ExampleConfiguration { }
In the above example a new ExampleConfiguration
bean will be created for each item under the foo.bar
key in application configuration
One can then drive the configuration of other beans with the same annotation:
@EachBean(ExampleConfiguration) @Singleton public class ExampleBean { ExampleBean(ExampleConfiguration config) { ... } }
Author: Graeme Rocher See Also: Since: 1.0
/**
* <p>This annotation allows driving the production of {@link Bean} definitions from presence of other bean definitions.
* Typically used in conjunction with {@link EachProperty}</p>
* <p>
* <p>For example:</p>
* <pre><code>
* {@literal @}EachProperty("foo.bar")
* public class ExampleConfiguration {
* }
* </code></pre>
* <p>
* <p>In the above example a new {@code ExampleConfiguration} bean will be created for each item under the
* {@code foo.bar} key in application configuration</p>
* <p>
* <p>One can then drive the configuration of other beans with the same annotation:</p>
* <pre><code>
* {@literal @}EachBean(ExampleConfiguration)
* {@literal @}Singleton
* public class ExampleBean {
* ExampleBean(ExampleConfiguration config) {
* ...
* }
* }
* </code></pre>
*
* @author Graeme Rocher
* @see EachProperty
* @see ConfigurationProperties
* @since 1.0
*/
@Documented
@Retention(RUNTIME)
@Target({ElementType.METHOD, ElementType.TYPE})
@Singleton
public @interface EachBean {
Returns: The bean type that this bean is driven by
/**
* @return The bean type that this bean is driven by
*/
Class value();
}