001package Torello.HTML.Tools.Images;
002
003import Torello.HTML.HTMLNode;
004import java.util.Vector;
005import java.util.function.ToIntFunction;
006
007/**
008 * If there is 'HTML Clutter' surrounding the image-html, this functional-interface can be used
009 * to eliminate such clutter.
010 * 
011 * <BR /><BR />Should remove any extraneous text from an HTML Page.  The returned integer should
012 * state exactly how many nodes were removed.
013 * 
014 * <BR /><BR />This interface inherits Java's Simple {@code ToIntFunction<T>}.  The lamda-target
015 * method is named {@code 'applyAsInt'}, and accepts a single parameter of type
016 * {@code Vector<HTMLNode>} (a.k.a the Vectorized-HTML Section).  This method should perform any
017 * cleaning on the Web-Page, and then it should return an integer stating how many nodes were
018 * removed (if any).
019 */
020@FunctionalInterface
021public interface TextCleaner extends ToIntFunction<Vector<HTMLNode>>
022{
023    /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUIDFI>  */
024    public static final long serialVersionUID = 1;
025}