net.namibsun.anitheme.dl.lib.parsing

Class Theme

net.namibsun.anitheme.dl.lib.parsing.Theme

public class Theme

The Theme class models an anime theme song indexed on themes.moe.

It consists of a short description as displayed on themes.moe, as well as a URL to the video file of the theme song

See Also:

themes.moe, themes.moe

Constructor Summary

Constructors

Constructor and Description
Theme(java.lang.String description, java.lang.String url) The Theme class models an anime theme song indexed on themes.moe.

Method Summary

Modifier and Type	Method and Description
void	abortDownload(java.lang.String target) Aborts the download. Resets the Theme.getDownloading flag and deletes the target file
void	download(java.lang.String targetDir, java.util.List<? extends net.namibsun.anitheme.dl.lib.parsing.FileTypes> fileTypes, java.lang.String prefix, java.lang.String suffix, int retriesAllowed) Downloads the theme song file to the specified target directory using an automatic naming scheme
void	downloadFile(java.lang.String target, int retriesAllowed) Downloads the file from the URL to a local file. Starts a separate thread that prints the current progress to the terminal Handles retries of downloads
java.lang.String	getDescription() The description of the theme song
boolean	getDownloading() Instance variable that is set to true whenever a download is progressing.
java.util.logging.Logger	getLogger()
java.lang.String	getUrl() The URL to the theme song file
void	handleConversion(java.lang.String name, java.lang.String webmFile, java.util.List<? extends net.namibsun.anitheme.dl.lib.parsing.FileTypes> fileTypes) Handles the conversion of the WEBM files to the various specified formats
void	handleDownload(java.lang.String targetFile, java.util.List<? extends net.namibsun.anitheme.dl.lib.parsing.FileTypes> fileTypes, int retriesAllowed) Handles the different cases of the existing file structure's state and delegates downloading and converting.
void	handleExceptionInDownload(java.lang.Exception exception, java.lang.String target, int retries, int maxRetries) Handles an exception caught in the Theme.downloadFile method Allows for retries, if the maximum amount of retries is exceeded, throws the exception again, after aborting the download.
void	printDownloadProgress(java.lang.String target, int size) Starts a new thread which continuously prints the current progress to the terminal
void	setDownloading(boolean p) Instance variable that is set to true whenever a download is progressing.
java.lang.String	toString() Formats the class Theme object for printing to the console

Constructor Detail

Theme

public Theme(java.lang.String description,
             java.lang.String url)

The Theme class models an anime theme song indexed on themes.moe.

It consists of a short description as displayed on themes.moe, as well as a URL to the video file of the theme song

Parameters:

description - The description of the theme song

url - The URL to the theme song file

description - The description of the theme song

url - The URL to the theme song file

See Also:

themes.moe, themes.moe

Method Detail

getLogger

public java.util.logging.Logger getLogger()

getDownloading

public boolean getDownloading()

Instance variable that is set to true whenever a download is progressing.

setDownloading

public void setDownloading(boolean p)

Instance variable that is set to true whenever a download is progressing.

download

public void download(java.lang.String targetDir,
                     java.util.List<? extends net.namibsun.anitheme.dl.lib.parsing.FileTypes> fileTypes,
                     java.lang.String prefix,
                     java.lang.String suffix,
                     int retriesAllowed)

Downloads the theme song file to the specified target directory using an automatic naming scheme

The description is used as the file name, a suffix and prefix may also be supplied The downloader can automatically convert the file into different file types. By default, only the original .webm file is kept

This method only generates a filename based off the information provided, then delegates the file download and conversion to the Theme.handleDownload method

Parameters:

targetDir - The target directory in which the file should be saved

fileTypes - The filetypes to convert the file into. Defaults to only .webm

prefix - An optional prefix for the generated file name

suffix - An optional suffix for the generated file name

retriesAllowed - The amount of times the download should be retried before giving up.

Throws:

- If an IO error occurs (for example, the URL is invalid)

- If the directory could not be created

See Also:

Theme.handleDownload

handleDownload

public void handleDownload(java.lang.String targetFile,
                           java.util.List<? extends net.namibsun.anitheme.dl.lib.parsing.FileTypes> fileTypes,
                           int retriesAllowed)

Handles the different cases of the existing file structure's state and delegates downloading and converting.

The fileTypes parameter specifies which media formats the file should be converted to. By default, only the original .webm file is downloaded and left as-is.

Parameters:

targetFile - The file name of the target file, without any file type associated suffixes like .webm etc.

fileTypes - The types of media files to convert the theme song into once downloaded

retriesAllowed - The amount of times the download should be retried before giving up.

Throws:

- if something happened during the download

downloadFile

public void downloadFile(java.lang.String target,
                         int retriesAllowed)

Downloads the file from the URL to a local file. Starts a separate thread that prints the current progress to the terminal Handles retries of downloads

Parameters:

target - The target file of the download in the local file system

retriesAllowed - The amount of retries that are allowed

handleExceptionInDownload

public void handleExceptionInDownload(java.lang.Exception exception,
                                      java.lang.String target,
                                      int retries,
                                      int maxRetries)

Handles an exception caught in the Theme.downloadFile method Allows for retries, if the maximum amount of retries is exceeded, throws the exception again, after aborting the download.

Parameters:

exception - The caught exception

target - The target file to which is being downloaded

retries - The amount of retries already attempted

maxRetries - The maximum amount of retries allowed

See Also:

Theme.downloadFile

abortDownload

public void abortDownload(java.lang.String target)

Aborts the download. Resets the Theme.getDownloading flag and deletes the target file

Parameters:

target - The target file to delete on abort

See Also:

Theme.getDownloading

printDownloadProgress

public void printDownloadProgress(java.lang.String target,
                                  int size)

Starts a new thread which continuously prints the current progress to the terminal

Parameters:

target - The target file. Used to check the current size

size - The total size of the download target in bytes

handleConversion

public void handleConversion(java.lang.String name,
                             java.lang.String webmFile,
                             java.util.List<? extends net.namibsun.anitheme.dl.lib.parsing.FileTypes> fileTypes)

Handles the conversion of the WEBM files to the various specified formats

Parameters:

name - The name of the downloaded file without any extension

webmFile - the path to the original webm file

fileTypes - The file types to which to convert to

toString

public java.lang.String toString()

Formats the class Theme object for printing to the console

This is done in the following format:

    Description: URL

Returns:

The formatted String

See Also:

class Theme

getDescription

public java.lang.String getDescription()

The description of the theme song

getUrl

public java.lang.String getUrl()

The URL to the theme song file