DownloadContext (univocity-html-parser-api 2.0.0 API)

```
public interface DownloadContext
```
Provides all information available during a “fetch resources” operation to a DownloadHandler callback, and allows the user to skip the download of certain file types.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`baseUri()` The current base URI associated with the document whose resources are being fetched.
`boolean`	`downloadSkipped()` Returns a flag indicating that this download has been skipped .
`boolean`	`downloadsStopped()` Returns a flag indicating that all downloads have been stopped
`URL`	`downloadUrl()` Returns the fully assembled URL pointing to a remote resource, which will be used to perform the download into the `targetFile()`.
`String`	`originalDownloadLink()` Returns the original link extracted from the HTML or CSS file.
`File`	`parentCssFile()` Returns the CSS file that is going to be updated after the fetch resources operation is complete.
`File`	`parentDir()` The directory where the `parentHtmlFile()` is located.
`File`	`parentHtmlFile()` Returns the HTML file that is going to be updated/generated after the fetch resources operation is complete.
`com.univocity.api.io.RateLimiter`	`rateLimiter()` Returns the `RateLimiter` being used during the fetch resources operation to slow down the rate of downloads being performed.
`void`	`setBaseUri(String baseUri)` Modifies the current base URI associated with the document whose resources are being fetched.
`void`	`setTargetFile(File newFile)` Changes the download destination to a new location.
`void`	`skipDownload()` Skips this download and moves on to the next.
`HtmlElement`	`sourceElement()` Returns the specific `HtmlElement` of the HTML that has a reference to the resource being downloaded.
`void`	`stopAllDownloads()` Skips this download and stops any active downloads, finalizing the fetch operation
`File`	`targetFile()` Returns the local target `File` where the downloaded contents will be saved.
`String`	`targetFileExtension()` Returns the extension of the `targetFile()`.
`String`	`targetRelativePath()` Returns the relative path of the file being downloaded.

- Method Detail
  - baseUri
```
String baseUri()
```
    The current base URI associated with the document whose resources are being fetched. Used to “build” the full URL used to download a given resource. For example, if a link such as <a href="/Images/Icons/garage.svg"></a> is being processed, and the base URI is set to http://www.univocity.com, the download URL will be http://www.univocity.com/Images/Icons/garage.svg
    
    Returns:
    
    the base URI if available, or an empty String
  - setBaseUri
```
void setBaseUri(String baseUri)
```
    Modifies the current base URI associated with the document whose resources are being fetched. Used to “build” the full URL used to download a given resource. For example, if a link such as <a href="/Images/Icons/garage.svg"></a> is being processed, and the base URI is set to http://www.univocity.com, the download URL will be http://www.univocity.com/Images/Icons/garage.svg
    
    Parameters:
    
    baseUri - the base URI to use for generating absolute download URL paths.
  - rateLimiter
```
com.univocity.api.io.RateLimiter rateLimiter()
```
    Returns the RateLimiter being used during the fetch resources operation to slow down the rate of downloads being performed. This rate limiter is configured via FetchOptions.getRemoteInterval() and is not associated with the setting in RemoteParserSettings.getRemoteInterval().
    
    Returns:
    
    the active rate limiter used during the fetch resources operation.
  - sourceElement
```
HtmlElement sourceElement()
```
    Returns the specific HtmlElement of the HTML that has a reference to the resource being downloaded. Any attribute of this element that points to a remote resource will be updated to point to the file downloaded locally. Will only return a non-null element when parentHtmlFile() returns a valid File.
    
    This method will return null when a CSS file is being updated to point to local resources, i.e. parentHtmlFile() returns null and parentCssFile() returns a valid File.
    
    Returns:
    
    the HTML element whose relevant attributes will be updated to point to a local file instead of the remote resource, or null if the file to download originates from a CSS file.
  - parentHtmlFile
```
File parentHtmlFile()
```
    Returns the HTML file that is going to be updated/generated after the fetch resources operation is complete. All HTML nodes that have attributes pointing to a remote resource that could be downloaded will be modified to point to the locally downloaded files.
    
    The resulting HTML file will not have a <base> tag.
    
    Returns:
    
    the updated HTML file using local resources.
  - parentCssFile
```
File parentCssFile()
```
    Returns the CSS file that is going to be updated after the fetch resources operation is complete. All URLs pointing to a remote resource that could be downloaded will be modified to point to the locally downloaded files. Paths to these files will be relative to the CSS file location.
    
    Returns:
    
    the updated CSS file using local resources.
  - parentDir
```
File parentDir()
```
    The directory where the parentHtmlFile() is located.
    
    Returns:
    
    the parent directory of the HTML being updated.
  - targetFile
```
File targetFile()
```
    Returns the local target File where the downloaded contents will be saved. The file may exist already and will be overwritten if FetchOptions.isOverwriteSharedResources() evaluates to true.
    
    Returns:
    
    the target file being downloaded.
  - setTargetFile
```
void setTargetFile(File newFile)
```
    Changes the download destination to a new location.
    
    Parameters:
    
    newFile - the download destination of the targetFile()
  - targetFileExtension
```
String targetFileExtension()
```
    Returns the extension of the targetFile(). Will never be null.
    
    Returns:
    
    the target file extension, without the dot.
  - targetRelativePath
```
String targetRelativePath()
```
    Returns the relative path of the file being downloaded. The path will be relative to the location of the HTML file if parentHtmlFile() is not null, or relative to the CSS file if parentCssFile() is notnull`.
    
    Returns:
    
    the path to the current file, relative to its parent HTML or CSS file.
  - originalDownloadLink
```
String originalDownloadLink()
```
    Returns the original link extracted from the HTML or CSS file. For example, when fetching the resources of <a href="/Images/Icons/garage.svg"></a>, this method will return /Images/Icons/garage.svg.
    
    Returns:
    
    the text of the link to a remote resource as originally found in the input HTML or CSS.
  - downloadUrl
```
URL downloadUrl()
```
    Returns the fully assembled URL pointing to a remote resource, which will be used to perform the download into the targetFile().
    
    Returns:
    
    returns the absolute download URL
  - skipDownload
```
void skipDownload()
```
    Skips this download and moves on to the next.
  - downloadSkipped
```
boolean downloadSkipped()
```
    Returns a flag indicating that this download has been skipped .
    
    Returns:
    
    whether the current download has been skipped.
  - stopAllDownloads
```
void stopAllDownloads()
```
    Skips this download and stops any active downloads, finalizing the fetch operation
  - downloadsStopped
```
boolean downloadsStopped()
```
    Returns a flag indicating that all downloads have been stopped
    
    Returns:
    
    whether the fetch operation has been stopped.

Interface DownloadContext

Method Summary

Method Detail

baseUri

setBaseUri

rateLimiter

sourceElement

parentHtmlFile

parentCssFile

parentDir

targetFile

setTargetFile

targetFileExtension

targetRelativePath

originalDownloadLink

downloadUrl

skipDownload

downloadSkipped

stopAllDownloads

downloadsStopped