• Home
• com.univocity
• univocity-html-parser-api
• 2.2.1
• source code
• DownloadHandler.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.univocity.api.entity.html.DownloadHandler Maven / Gradle / Ivy

/*
 * Copyright (c) 2013 Univocity Software Pty Ltd. All rights reserved.
 * This file is subject to the terms and conditions defined in file
 * 'LICENSE.txt', which is part of this source code package.
 */

package com.univocity.api.entity.html;

import java.io.*;

/**
 * A callback interface for downloads handled by a "fetch resources" operation, which downloads all resources referenced
 * by a given HTML input. This callback is used when {@link HtmlElement#fetchResources(File, FetchOptions)} is executed,
 * or when the {@link HtmlParserSettings#fetchResourcesBeforeParsing(FetchOptions)} is used, where
 * {@link FetchOptions#getDownloadHandler()} returns a non-null value.
 *
 * @see DownloadContext
 * @see FetchOptions
 * @see HtmlElement
 * @see HtmlParserSettings
 */
public interface DownloadHandler {

	/**
	 * Informs the user that a resource is ready to be downloaded. Use the {@code context} object to control the process.
	 * For example, you can use {@link DownloadContext#targetFileExtension()} to prevent the download of certain types
	 * of files - just call {@link DownloadContext#skipDownload()} to prevent the download from happening.
	 *
	 * @param context an object with all information available about the download to performed,
	 *                and options to skip or cancel the fetch operation altogether
	 */
	void nextDownload(DownloadContext context);
}