fr.whimtrip.ext.jwhtscrapper.annotation.LinkObjects Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of whimtrip-ext-scrapper Show documentation

Fully featured highly pluggable and customizable Java scrapping framework

The newest version!

/*
 * This code is licensed to WhimTrip©. For any question, please contact the author of the file.
 */

/*
 * This code is licensed to WhimTrip©. For any question, please contact the author of the file.
 */

package fr.whimtrip.ext.jwhtscrapper.annotation;

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


/**
 * Part of project jwht-scrapper
 * Created on 29/07/18
 *
 * 
 *     This annotation can be applied to any List of POJO
 *     typed field of a POJO.
 * 
 *
 * 
 *     All {@link Link} annotated fields whose field names will be in
 *     {@link #value()} field of this annotation will be mapped and
 *     added to the {@link LinkObjects} annotated list field.
 * 
 *
 * @see Link
 * @see LinkObject
 * @author Louis-wht
 * @since 1.0.0
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD })
public @interface LinkObjects {

    /**
     * @return the names of the {@link Link} annotated fields of your POJO
     *         to scrap, map and add to the current {@link LinkObjects}
     *         annotated POJO list field.
     */
    String[] value();

}