org.springframework.contributions.annotation.ContributionMapped Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spring-contributions Show documentation

This project adds a so called contribution mechanism (like known from Tapestry IOC or Eclipse Plugins) for configuration and extension of services to the Spring project.

There is a newer version: 2.0.0

Show newest version

package org.springframework.contributions.annotation;

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

/**
 * This annotation can be used inside of spring java configuration classes to add a bean to a mapped
 * contribution.
 * 
 * @author Ortwin Probst
 */
@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ContributionMapped
{

	/**
	 * The name of the bean to be contributed (added to the mapped contribution. This property is
	 * optional. If not provided the name of the bean definition method will be considered as the
	 * beans name.
	 * 
	 * @return
	 */
	String bean() default "";

	/**
	 * The name of the mapped contribution bean where the contributed bean will be added to
	 * 
	 * @return
	 */
	String to();

	/**
	 * The name of the bean which will be used as the key in the mapped contribution for the bean to
	 * be contributed.
	 * 
	 * @return
	 */
	String key() default "";

	/**
	 * The class which will be used as the key in the mapped contribution for the bean to be
	 * contributed.
	 * 
	 * @return
	 */
	Class keyClass() default ContributionMapped.class;

	/**
	 * The value of the Enum used as key
	 * 
	 * @return
	 */
	String keyEnumValue() default "";
	
	/**
	 * The class of the Enum used as key
	 * 
	 * @return
	 */
	Class> keyEnumClass() default NoEnumKey.class;

	/**
	 * this enum is used as default return value for {@link ContributionMapped#keyEnumClass()} to
	 * indicate that no enum key was defined in the configuration.
	 */
	enum NoEnumKey{}
}