Package org.jtrim2.ui.concurrent.query

Interface RenderingState

public interface RenderingState
Defines the state of an asynchronous rendering request. This result is intended to be associated with a rendering request passed to an AsyncRenderer.

Thread safety

Implementations of this interface are required to be safe to be accessed from multiple threads concurrently.

Synchronization transparency

Implementations of this interface are not required to be synchronization transparent.
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    AsyncDataState
    getAsyncDataState()
    Returns the state of asynchronous data retrieval process associated with the rendering.
    long
    getRenderingTime(TimeUnit unit)
    Returns the time elapsed since the rendering started.
    boolean
    isRenderingFinished()
    Returns true if the asynchronous rendering process has completed.

  • Method Details

    • isRenderingFinished

      boolean isRenderingFinished()
      Returns true if the asynchronous rendering process has completed. When this object refers to a DataRenderer this implies that the finishRendering method of the associated DataRenderer has already returned.
      Returns:
      true if the asynchronous rendering process has completed, false otherwise

    • getRenderingTime

      long getRenderingTime(TimeUnit unit)
      Returns the time elapsed since the rendering started. The return value of this method is independent of the completion of the rendering request.
      Parameters:
      unit - the time unit in which the result is to be interpreted. This argument cannot be null.
      Returns:
      the time in the specified time unit elapsed since the start of the associated rendering request
      Throws:
      NullPointerException - thrown if the specified argument is null

    • getAsyncDataState

      AsyncDataState getAsyncDataState()
      Returns the state of asynchronous data retrieval process associated with the rendering. That is, this method returns the state returned by the AsyncDataLink passed to AsyncRenderer.render.
      Returns:
      the state of asynchronous data retrieval process associated with the rendering. This method may return null if the state is not available.