org.eobjects.analyzer.beans.api.Validate Maven / Gradle / Ivy
/**
* 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.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Annotation that marks method as a validation method. Use this annotation if
* you want to validate property values before initialization.
*
* The @Initialize annotation can be used on methods in the following component
* types:
*
*
* - AnalyzerBeans
* - TransformerBeans
* - FilterBeans
* - Dictionaries
* - SynonymCatalog
* - StringPattern
* - ... and custom configuration elements, such as custom datastores and
* custom task runners (in which case the semantics are a bit different - they
* will only be validated once, just after loading the configuration).
*
*
* The method is invoked after any @Configured and @Provided methods/fields are
* invoked/assigned but before initialization and any business methods (such as
* run(...) on an analyzer) are invoked.
*
* Validation methods should be repeatable and rather lightweight, since they
* might be called multiple times on any single component.
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
@Inherited
public @interface Validate {
}