Package com.iizix.server.webthumbs

Class WebThumbnail

  • public class WebThumbnail
extends java.lang.Object
    Class holding information about a thumbnail of a web site, typically "apple.com" or "www.apple.com", such as can be viewed in a browser.

    • Method Detail

      • isDisposed

        public boolean isDisposed()
        Checks if disposed.
        Returns:
        true if disposed of.

      • waitForCompletion

        public WebThumbnailState waitForCompletion​(java.lang.Runnable runnable)
        Waits for completion of the loading. The state must be in PENDING or LOADING mode. The current thread is blocked until it completes.

        Once the loading has completed, the runnable will be invoked. Please note that if the WebThumbnail instance has been disposed of, no call to the runnable will be performed.

        Parameters:
        runnable - Called when the loading completed, with or without error. Please check the getState() or getException().
        Returns:
        The state of the thumbnail.

      • addCompletionListener

        public WebThumbnailState addCompletionListener​(java.lang.Runnable runnable)
        Adds a completion listener that will wait for completion of the loading. The state must be in PENDING or LOADING mode.

        The current thread is blocked until it completes. If you do not wish to have a blocking operation, use the addListener(IWebThumbnailListener) method instead.

        Once the loading has completed, the runnable will be invoked. Please note that if the WebThumbnail instance has been disposed of, no call to the runnable will be performed.

        Parameters:
        runnable - Called when the loading completed, with or without error. Please check the getState() or getException().
        Returns:
        The state of the thumbnail.

      • getFile

        public java.io.File getFile()
        Gets the file in the file provider system that should be used for the web site thumbnail: 1280 x 1024. The file might not exist!
        Returns:
        The file, it might NOT be loaded yet, this is can be null!

      • getWSFile

        public IWSFile getWSFile()
        Gets the Web Server File that should be used for the web site thumbnail: 1280 x 1024.
        Returns:
        The wsFile, it might NOT be loaded yet, this is can be null!

      • getState

        public WebThumbnailState getState()
        Gets the state of the thumbnail process.
        Returns:
        The enumeration value of State.

      • getException

        public java.lang.Throwable getException()
        The exception the caused the failure when performing the loading of the thumbnail for the web site.
        Returns:
        The exception, or null for none.

      • getSite

        public java.lang.String getSite()
        Gets the web site of the thumbnail.
        Returns:
        The web site string such as "apple.com" or "www.apple.com".

      • addListener

        public boolean addListener​(IWebThumbnailListener listener)
        Adds a listener for the loading state.

        Calling this method twice with the same listener will always return false.

        Parameters:
        listener - The listener that will be called from the loading thread.
        Returns:
        true when the listener is added successfully and that the state is not WebThumbnailState.PENDING and not WebThumbnailState.RETRIEVING.

      • removeListener

        public boolean removeListener​(IWebThumbnailListener listener)
        Removes a listener for the loading state.

        Calling this method twice with the same listener will always return false.

        Parameters:
        listener - The listener.
        Returns:
        true when the listener is removed successfully.