fr.whimtrip.ext.jwhtscrapper.service.holder.LinkPreparatorHolder 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.service.holder;

import fr.whimtrip.ext.jwhtscrapper.enm.Method;
import fr.whimtrip.ext.jwhtscrapper.exception.LinkException;
import fr.whimtrip.ext.jwhtscrapper.intfr.HttpRequestEditor;
import fr.whimtrip.ext.jwhtscrapper.service.scoped.LinksFollowerImpl;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.List;

/**
 * Part of project jwht-scrapper
 * Created on 28/07/18
 *
 * 
 *     Inner holder class used by {@link LinksFollowerImpl}. It will hold a partial
 *     link preparation context so that it can be further sent as a simple object
 *     wether than a complex parameter agglomeration in corresponding methods.
 * 
 *
 * @author Louis-wht
 * @since 1.0.0
 */
public class LinkPreparatorHolder {

    private final P parent;

    private final String url;

    private final Method method;

    private final List fields;

    private final java.lang.reflect.Field parentField;

    private final Class requestEditorClazz;

    private final boolean followRedirections;

    private final boolean throwExceptions;

    /**
     * 
Default constructor of this clas
     * @param parent see {@link #getParent()}
     * @param url see {@link #getUrl()}
     * @param method see {@link #getMethod()}
     * @param fields see {@link #getFields()}
     * @param parentField see {@link #getParentField()}
     * @param requestEditorClazz see {@link #getRequestEditorClazz()}
     * @param followRedirections see {@link #followRedirections()}
     * @param throwExceptions see {@link #throwExceptions()}
     */
    public LinkPreparatorHolder(
            @NotNull  final P parent,
            @NotNull  final String url,
            @NotNull  final Method method,
            @Nullable final List fields,
            @NotNull  final java.lang.reflect.Field parentField,
            @Nullable  final Class requestEditorClazz,
                      final boolean followRedirections,
                      final boolean throwExceptions
    ){

        this.parent = parent;
        this.url = url;
        this.method = method;
        this.fields = fields;
        this.parentField = parentField;
        this.requestEditorClazz = requestEditorClazz;
        this.followRedirections = followRedirections;
        this.throwExceptions = throwExceptions;
    }

    /**
     * @return the parent POJO that should contain child POJO or list of
     *         child POJOs that will be preparated through this holder class.
     */
    public P getParent() {
        return parent;
    }

    /**
     * @return the url to scrap at.
     */
    public String getUrl() {
        return url;
    }

    /**
     * @return the {@link Method} HTTP method to use for the scrapping process.
     */
    public Method getMethod() {
        return method;
    }

    /**
     * @return the list of {@link PostField} to add to the HTTP request if POST
     *         request.
     */
    public List getFields() {
        return fields;
    }

    /**
     * @return the {@link HttpRequestEditor} class to use if any to modify and alter the
     *         request building process with custom processing unit.
     */
    public Class getRequestEditorClazz() {
        return requestEditorClazz;
    }

    /**
     * @return the parent field to set the resulting scrapped value to.
     */
    public java.lang.reflect.Field getParentField() {
        return parentField;
    }

    /**
     * @return wether HTTP redirections should be followed or not.
     */
    public boolean followRedirections() {
        return followRedirections;
    }

    /**
     * @return wether {@link LinkException} should be catched or thrown.
     */
    public boolean throwExceptions() {
        return throwExceptions;
    }

}