uk.org.retep.kernel.annotations.Bean Maven / Gradle / Ivy
/*
* Copyright (c) 1998-2010, Peter T Mount
* All rights reserved.
*
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
*
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
*
*
* You should have received a copy of the GNU General Public License along
* with this program. If not, see
*
*
* GNU GENERAL PUBLIC LICENSE - CLASSPATH EXCEPTION
*
*
*
* Linking this library statically or dynamically with other modules
* is making a combined work based on this library. Thus, the terms
* and conditions of the GNU General Public License cover the whole
* combination.
*
*
*
* As a special exception, the copyright holders of this library give
* you permission to link this library with independent modules to
* produce an executable, regardless of the license terms of these
* independent modules, and to copy and distribute the resulting
* executable under terms of your choice, provided that you also meet,
* for each linked independent module, the terms and conditions of the
* license of that module.
*
*
*
* An independent module is a module which is either not derived from or based
* on this library, or a module who's classes extend those within this library
* as part of the implementation of the library.
*
*
*
* If you modify this library, you may extend this exception to your version
* of the library, but you are not obligated to do so. If you do not wish to
* do so, delete this exception statement from your version.
*
*/
package uk.org.retep.kernel.annotations;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* This annotation defines a bean that will be registered within the Kernel.
*
*
* There are two ways this Annotation can be used. When annotated against a type,
* the clas can be annotated with all of the other annotations, including @Init
* and @Destroy annotations.
*
*
*
* The other is when a method is annotated. In that instance, the method is called
* to obtain the deployed instance. Only @Reference and @Value annotations
* may be used against the method's parameters. Also, for this form, if the method
* is not static then the outer class must also be defined with @Bean.
*
*
* @author peter
* @see BeanFactory
* @see Destroy
* @see FactoryMethod
* @see Init
* @see PostInit
*/
@Target( { ElementType.TYPE, ElementType.METHOD } )
@Retention( RetentionPolicy.CLASS )
public @interface Bean
{
/**
* The name of the bean within the Kernel.
* @return
*/
String name();
/**
* Should this bean be lazy initialised (default)
* @return true for lazy initialisation, false for the bean to be forcably
* initialised.
*/
boolean lazyInit() default true;
String autowire() default "";
boolean autowireCandidate() default true;
}