Interface ISessionContextManager

All Known Implementing Classes:
JdmpviewContextManager
public interface ISessionContextManager
Controls the creation and deletion of contexts within a session.

  • Method Summary

    Modifier and Type
    Method
    Description
    ICombinedContext
    getContext(int id)
    Gets the context with the specified ID.
    Map<URI,ArrayList<ICombinedContext>>
    getContexts()
    Lists all contexts keyed by the URI from which they were derived.
    boolean
    hasChanged()
    A number of internal operations which could affect the list of currently open and available contexts happen in an unlinked or asynchronous manner.
    boolean
    hasMultipleContexts()
    Convenience method for determining if more than one context is currently open.
    void
    removeAllContexts()
    Close and remove all contexts from this manager.
    void
    removeContexts(Image image)
    Remove all contexts which have been derived from an image source.
    void
    removeContexts(URI source)
    Remove all contexts which have been defined as coming from a specified URI (note that the URI may or may not be a file URI).

  • Method Details

    • removeContexts

      void removeContexts(Image image)
      Remove all contexts which have been derived from an image source. e.g. if there are multiple JVMs in a single core then closing the core file would result in all images derived from that file also being closed.
      Parameters:
      image - the source image from which derived contexts should be closed.

    • removeContexts

      void removeContexts(URI source)
      Remove all contexts which have been defined as coming from a specified URI (note that the URI may or may not be a file URI).
      Parameters:
      URI - the source URI from which derived contexts should be closed.

    • removeAllContexts

      void removeAllContexts()
      Close and remove all contexts from this manager.

    • getContexts

      Map<URI,ArrayList<ICombinedContext>> getContexts()
      Lists all contexts keyed by the URI from which they were derived.
      Returns:
      map of URI's to contexts

    • hasMultipleContexts

      boolean hasMultipleContexts()
      Convenience method for determining if more than one context is currently open. It is a less expensive call than getContexts()
      Returns:
      true if more than one context is currently open and available

    • getContext

      ICombinedContext getContext(int id)
      Gets the context with the specified ID.
      Parameters:
      id - the context ID
      Returns:
      the located context or null if it was not found

    • hasChanged

      boolean hasChanged()
      A number of internal operations which could affect the list of currently open and available contexts happen in an unlinked or asynchronous manner. By calling this method the session (or external clients) are able to tell if the list of contexts has changed and anything related to this such as a display may need to be update.
      Returns: