Class PluginEvent

    • Field Summary

      Modifier and Type Field Description
      static java.lang.String EXTERNAL_SOURCE_NAME
      Name of event source when plugin event is passed to another tool as cross-tool event.
    • Constructor Summary

      Modifier Constructor Description
      protected PluginEvent​(java.lang.String sourceName, java.lang.String eventName)
    • Field Detail


        public static final java.lang.String EXTERNAL_SOURCE_NAME
        Name of event source when plugin event is passed to another tool as cross-tool event.
        See Also:
        Constant Field Values
    • Constructor Detail

      • PluginEvent

        protected PluginEvent​(java.lang.String sourceName,
                              java.lang.String eventName)
        sourceName - source name of the event
        eventName - name of event
    • Method Detail

      • lookupToolEventName

        public static java.lang.String lookupToolEventName​(java.lang.Class<?> pluginEventClass)
        Returns the tool event name corresponding to the given pluginEventClass. If no corresponding tool event exists, null will be returned.
      • isToolEvent

        public boolean isToolEvent()
        Determine if this event has been annotated with a ToolEventName which makes it available for passing to another tool via a ToolConnection.
        true if event can be utilized as a cross-tool event
      • getToolEventName

        public final java.lang.String getToolEventName()
        Get the optional cross-tool event name which has been established via a ToolEventName annotation which makes it available for passing as an external tool via a ToolConnection. This name may differ from the getEventName().s
        tool event name or null if not permitted as a cross-tool event
      • getEventName

        public final java.lang.String getEventName()
        Get the plugin event name.
      • getSourceName

        public final java.lang.String getSourceName()
        Returns the name of the plugin immediately responsible for firing this event.
      • setSourceName

        public void setSourceName​(java.lang.String s)
      • setTriggerEvent

        public void setTriggerEvent​(PluginEvent triggerEvent)
      • getTriggerEvent

        public PluginEvent getTriggerEvent()
      • toString

        public java.lang.String toString()
        toString in class java.lang.Object
      • getDetails

        protected java.lang.String getDetails()