org.webharvest.annotation.Definition Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of webharvest-core Show documentation
The newest version!
package org.webharvest.annotation;

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;

import org.webharvest.definition.IElementDef;
import org.webharvest.definition.WebHarvestPluginDef;

/**
 * Annotation on {@link org.webharvest.runtime.processors.Processor} classes
 * specifying the {@link org.webharvest.definition.IElementDef} this particular
 * processor is described by.
 *
 * @author Robert Bala
 * @since 2.1.0-SNAPSHOT
 * @version %I%, %G%
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE })
@Inherited
@Documented
public @interface Definition {

    /**
     * Defines name of the processor. Should be valid identifier. Processor's
     * tag will use this name. For example, if this name is "myprocessor" in
     * config file it will be used as
     * <myprocessor...>...</myprocessor>
     *
     * @return Name of the processor
     */
    String value();

    /**
     * The definition type that the processor is mapped to.
     */
    Class definitionClass() default WebHarvestPluginDef.class;

    /**
     * This method should return all possible attribute names for the plugin processor.
     *
     * @return Array of attribute names
     */
    String[] validAttributes() default {};

    /**
     * This method should return all mandatory attribute names for the plugin processor.
     *
     * @return Array of attribute names
     */
    String[] requiredAttributes() default {};

    /**
     * Defines dependant subprocessors that are used inside this plugin and that will
     * automatically be registered with this plugin.
     *
     * @return Array of subprocessor classes
     */
    Class[] dependantProcessors() default {};

    boolean body() default true;

    /**
     * This method should return all names of all allowed processors inside the body of
     * this processor plugin. If null is returned, then all subprocessors are allowed.
     *
     * @return Array of allowed subprocessor names (case insensitive)
     */
    String[] validSubprocessors() default {};

    /**
     * This method should return all mandatory subprocessor names, or in other words all
     * mandatory subtags that must be present in the body of this processor plugin.
     *
     * @return Array of mandatory subprocessor names
     */
    String[] requiredSubprocessors() default {};

    boolean internal() default false;

}