org.eobjects.analyzer.beans.api.Alias Maven / Gradle / Ivy

Go to download

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

Public API for component developers of AnalyzerBeans

There is a newer version: 1.0.6

/**
 * eobjects.org AnalyzerBeans
 * Copyright (C) 2010 eobjects.org
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, 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 Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.eobjects.analyzer.beans.api;

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;

/**
 * Annotation used to specify optional alias(es) for a component or a
 * {@link Configured} property.
 * 
 * Aliases can be used as a way of providing backwards compatibility to
 * components or properties that are renamed (by specifying the old name as an
 * alias).
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.FIELD, ElementType.TYPE })
@Documented
public @interface Alias {

	/**
	 * Defines the alias(es) of the component or configured property.
	 * 
	 * @return the aliases of the component or configuration property
	 */
	String[] value();
}