package Torello.HTML.Tools.Images;

import Torello.HTML.HTMLNode;
import java.util.Vector;
import java.util.function.ToIntFunction;

/**
 * If there is 'HTML Clutter' surrounding the image-html, this functional-interface can be used
 * to eliminate such clutter.
 * 
 * <BR /><BR />Should remove any extraneous text from an HTML Page.  The returned integer should
 * state exactly how many nodes were removed.
 * 
 * <BR /><BR />This interface inherits Java's Simple {@code ToIntFunction<T>}.  The lamda-target
 * method is named {@code 'applyAsInt'}, and accepts a single parameter of type
 * {@code Vector<HTMLNode>} (a.k.a the Vectorized-HTML Section).  This method should perform any
 * cleaning on the Web-Page, and then it should return an integer stating how many nodes were
 * removed (if any).
 */
@FunctionalInterface
public interface TextCleaner extends ToIntFunction<Vector<HTMLNode>>
{
    /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUIDFI>  */
    public static final long serialVersionUID = 1;
}