fr.whimtrip.ext.jwhtscrapper.enm.Action 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!

package fr.whimtrip.ext.jwhtscrapper.enm;

import fr.whimtrip.ext.jwhtscrapper.annotation.Scrapper;

/**
 * Part of project jwht-scrapper
 * Created on 29/07/18
 *
 * 
 *     This enumeration defines all possible actions that can be taken when
 *     a warning sign is triggered.
 * 
 *
 * @author Louis-wht
 * @since 1.0.0
 *
 */
public enum Action {

    /**
     * Retry the request.
     */
    RETRY,

    /**
     * Throw an exception. This will have the same impact
     * as {@link #STOP_ACTUAL_SCRAP} except that the scrap
     * will be accounted as a failure, and if {@link Scrapper#throwExceptions()}
     * is set to true, it will completely stop the whole
     * scrapping operation.
     */
    THROW_EXCEPTION,

    /**
     * Stop the actual scrap without further links explored
     * and returned the current model in its actual state.
     */
    STOP_ACTUAL_SCRAP,

    /**
     * Won't do anything : the scrap will pursue where it was
     * without our current POJO being further analyzed. It will
     * act almost as with {@link #STOP_ACTUAL_SCRAP} except that
     * if the current scrapped POJO was itself a link followed,
     * the parent POJO scrap will continue.
     */
    NONE
}