org.androidannotations.annotations.Bean Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of androidannotations-api Show documentation

The API jar containing the annotations and the runtime helpers

There is a newer version: 4.8.0

Show newest version

/**
 * Copyright (C) 2010-2016 eBusiness Information, Excilys Group
 *
 * 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 org.androidannotations.annotations;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 
 * Injects an {@link EBean} annotated class in an enhanced class.
 * 
 * 
 * You can specify a specific implementation to inject using the value
 * attribute.
 * 
 * 
 * 
 * Example :
 * 
 *  * @EActivity
 * public class MyActivity extends Activity {
 * 
 * 	@Bean
 * 	MyBean myBean;
 * 
 * 	@Bean(MyBean2.class)
 * 	MyBean myBean2;
 * 
 * 	@Bean
 * 	void singleInjection(MyBean bean) {
 * 		// do stuff
 * 	}
 * 
 * 	@Bean(MyBean2.class)
 * 	void singleInjection2(MyBean bean) {
 * 		// do stuff
 * 	}
 * 
 * 	void multiInjection(@Bean MyBean bean1, @Bean MyBean bean2) {
 * 		// do stuff
 * 	}
 * 
 * 	void multiInjection2(@Bean(MyBean2.class) MyBean bean1, @Bean(MyBean2.class) MyBean bean2) {
 * 		// do stuff
 * 	}
 * 
 * }
 * 
 * @EBean
 * public class MyBean {
 * }
 * 
 * @EBean
 * public class MyBean2 extends MyBean {
 * }
 * 
 * 
 * 
 * 
 * @see EBean
 */
@Retention(RetentionPolicy.CLASS)
@Target({ ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER })
public @interface Bean {

	/**
	 * The implementation class of the injected bean.
	 * 
	 * @return the implementation class
	 */
	Class value() default Void.class;
}