Package com.iizix.wsfile

Interface IWSFileDownload

  • All Known Implementing Classes:
    WSFileDownload
    public interface IWSFileDownload
    Interface used to hold information for file download into a file provider.
    Author:
    Christopher Mindus

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      voiddispose()
      Disposes of the download if in progress.
      java.lang.StringgetDescription()
      Gets the description of the download file.
      java.lang.ThrowablegetException()
      Gets the exception from the download process or when writing the file.
      java.io.FilegetFile()
      Gets the download file.
      java.lang.ObjectgetID()
      Gets the ID used for database identification.
      java.net.URLgetURL()
      Gets the URL.
      booleanisDisposed()
      Checks if the download is disposed of (during progress).

    • Method Detail

      • getURL

        java.net.URL getURL()
        Gets the URL.
        Returns:
        The URL.

      • getID

        java.lang.Object getID()
        Gets the ID used for database identification.
        Returns:
        A Long or String, null when database is not used.

      • getDescription

        java.lang.String getDescription()
        Gets the description of the download file.
        Returns:
        The description.

      • getFile

        java.io.File getFile()
        Gets the download file.
        Returns:
        The file, or null if an exception occurred.

      • getException

        java.lang.Throwable getException()
        Gets the exception from the download process or when writing the file.
        Returns:
        The exception, or null if no error occurred.

      • dispose

        void dispose()
        Disposes of the download if in progress.

      • isDisposed

        boolean isDisposed()
        Checks if the download is disposed of (during progress).
        Returns:
        The dispose flag: true if download has been disposed of, i.e. canceled, false otherwise.