Package com.caplin.streamlink

Interface ContainerEvent

All Superinterfaces:
DataEvent
public interface ContainerEvent extends DataEvent

Represents an update to a container subject.

The ContainerEvent will be provided on a onContainerUpdate callback to a SubscriptionListener.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getSize()
    Gets the size of the container.
    int
    getWindowEnd()
    Gets the index of the end of the container window.
    int
    getWindowStart()
    Gets the index of the start of the window.
    boolean
    isImage()
    This value should NOT be used when processing container messages, the updateModel() method will apply a clear to the container structure if required.
    boolean
    isList()
    Returns true if this container event originates from a List object
    void
    updateModel(ContainerModel containerModel)
    Update your implementation of ContainerModel with the contents of this ContainerEvent.

    Methods inherited from interface com.caplin.streamlink.DataEvent

    getSubject

  • Method Details

    • getSize

      int getSize()

      Gets the size of the container.

      The value returned here is the true size of the container, which may be larger than the size of the container window that you have subscribed to.

      The value returned here is useful for sizing the scroll bars of a data view showing the elements within a container.

      Returns:
      The size of the container.

    • getWindowStart

      int getWindowStart()

      Gets the index of the start of the window.

      Returns:
      The start of the window, or -1 if no window has been specified.

    • getWindowEnd

      int getWindowEnd()

      Gets the index of the end of the container window.

      Returns:
      The end of the window, or -1 if no window has been specified.

    • updateModel

      void updateModel(ContainerModel containerModel)

      Update your implementation of ContainerModel with the contents of this ContainerEvent.

      Parameters:
      containerModel - Your implementation of ContainerModel that should be updated with the contents of this ContainerEvent.

    • isList

      boolean isList()

      Returns true if this container event originates from a List object

      Returns:

    • isImage

      boolean isImage()

      This value should NOT be used when processing container messages, the updateModel() method will apply a clear to the container structure if required.

      Specified by:
      isImage in interface DataEvent
      Returns:
      true if underlying RTTP message was an image, this will become a clear within the ContainerModel.