Interface PluginEvent


  • public interface PluginEvent
    (package-private)
    All information about a change of reader state within an ObservablePlugin.

    The getReaderNames() and getType() methods allow the event recipient to retrieve the names of the readers involved and the type of the event.

    Since the event provides a list of reader names, a single event can be used to notify a change for one or more readers.

    However, only one type of event is notified at a time.

    Since:
    2.0.0
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  PluginEvent.Type
      The two types of reader event
    • Method Detail

      • getPluginName

        java.lang.String getPluginName()
        Gets the name of the plugin to which the reader that generated the event belongs.
        Returns:
        A not empty string.
        Since:
        2.0.0
      • getReaderNames

        java.util.SortedSet<java.lang.String> getReaderNames()
        Gets the names of the readers related to the event in the form of a sorted set.
        Returns:
        A not null reference.
        Since:
        2.0.0
      • getType

        PluginEvent.Type getType()
        Gets the plugin event type.
        Returns:
        A not null reference.
        Since:
        2.0.0