org.demoiselle.annotation.Name Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of demoiselle Show documentation
There is a newer version: 3.0.0-ALPHA2
/*
 * Demoiselle Framework
 * Copyright (C) 2010 SERPRO
 * ----------------------------------------------------------------------------
 * This file is part of Demoiselle Framework.
 *
 * Demoiselle Framework is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License version 3
 * as published by the Free Software Foundation.
 *
 * 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 Lesser General Public License version 3
 * along with this program; if not,  see 
 * or write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA  02110-1301, USA.
 * ----------------------------------------------------------------------------
 * Este arquivo é parte do Framework Demoiselle.
 *
 * O Framework Demoiselle é um software livre; você pode redistribuí-lo e/ou
 * modificá-lo dentro dos termos da GNU LGPL versão 3 como publicada pela Fundação
 * do Software Livre (FSF).
 *
 * Este programa é distribuído na esperança que possa ser útil, mas SEM NENHUMA
 * GARANTIA; sem uma garantia implícita de ADEQUAÇÃO a qualquer MERCADO ou
 * APLICAÇÃO EM PARTICULAR. Veja a Licença Pública Geral GNU/LGPL em português
 * para maiores detalhes.
 *
 * Você deve ter recebido uma cópia da GNU LGPL versão 3, sob o título
 * "LICENCA.txt", junto com esse programa. Se não, acesse 
 * ou escreva para a Fundação do Software Livre (FSF) Inc.,
 * 51 Franklin St, Fifth Floor, Boston, MA 02111-1301, USA.
 */
package org.demoiselle.annotation;

import javax.enterprise.inject.spi.InjectionPoint;
import javax.enterprise.util.Nonbinding;
import javax.inject.Named;
import javax.inject.Qualifier;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * 
 * String based non-binding qualifier.
 * 
 *
 * 
 * This annotation is used to qualify beans using an user defined String. {@link javax.enterprise.inject.Produces}
 * methods can then read this string and use it to customize the bean creation process.
 * 
 *
 * 
 * The {@link #value()} attribute is non-binding (contrary to {@link Named#value()}, meaning multiple classes
 * qualified with this annotation, even with different values, will be considered the same candidate for
 * injection points. To avoid ambiguous resolutions and select which candidate to choose usually you'll need a
 * producer method to read the string and select the best fitted candidate.
 * 
 *
 * 
 * The framework classes qualified with this annotation already have such producers and the accepted values for
 * this annotation will be detailed in their respective documentations.
 * 
 *
 *
 * @author SERPRO
 *
 * @see org.demoiselle.util.ResourceBundle
 * @see org.demoiselle.internal.producer.ResourceBundleProducer#create(InjectionPoint)
 * @see org.demoiselle.internal.producer.LoggerProducer#createNamed(InjectionPoint)
 */
@Qualifier
@Inherited
@Retention(RUNTIME)
@Target({ TYPE, FIELD, METHOD, PARAMETER })
public @interface Name {

	/**
	 * 
	 * Specifies a name to access a custom configuration that will change how the annotated bean works.
	 * 
	 * 
	 * This attribute is nonbinding so you can use the {@link Name} annotation to create {@linkplain javax.enterprise.inject.Produces}
	 * methods or fields and have only one producer that works with all injection points no matter the value of this attribute.
	 * 
	 * @return Name of custom settings to personalize how the annotated bean works.
	 */
	@Nonbinding
	String value() default "";

}