Interface MacroPluginFramework

All Known Implementing Classes:
ExampleScriptingFramework

public interface MacroPluginFramework
Macro plugin framework interface defines the methods a plugin may use to access properties and methods of the surrounding framework.
Author:
Karl Eilebrecht
  • Method Summary

    Modifier and Type Method Description
    void addProtocolMessage​(java.lang.String source, java.lang.String message)
    Allows protocol messages.
    java.lang.Object getProperty​(java.lang.String propertyName)
    Returns the value of the requested property.
    boolean isPropertyAvailable​(java.lang.String propertyName)
    Returns whether the given property is currently known
    void setProperty​(java.lang.String propertyName, java.lang.Object value)
    Sets the value of the denoted property.
  • Method Details

    • getProperty

      java.lang.Object getProperty​(java.lang.String propertyName)
      Returns the value of the requested property.
      Parameters:
      propertyName - name of the property, case insensitive, NOT NULL
      Returns:
      mapped value
    • setProperty

      void setProperty​(java.lang.String propertyName, java.lang.Object value)
      Sets the value of the denoted property.
      Parameters:
      propertyName - name of the property, case insensitive, NOT NULL
      value - new value
    • isPropertyAvailable

      boolean isPropertyAvailable​(java.lang.String propertyName)
      Returns whether the given property is currently known
      Parameters:
      propertyName - name of property, case insensitive, NOT NULL
      Returns:
      true if property exists, otherwise false
    • addProtocolMessage

      void addProtocolMessage​(java.lang.String source, java.lang.String message)
      Allows protocol messages.
      Parameters:
      source - usually the plugin name
      message - info to be logged