Class AbstractUpdateableFilterPlugin

All Implemented Interfaces:
IAnalysisComponent, IFilterPlugin, IPlugin

@Deprecated
public abstract class AbstractUpdateableFilterPlugin
extends AbstractFilterPlugin
Deprecated.
since 1.15.1 old plugin api
Extends the AbstractFilterPlugin with possibilities to update properties that are marked as updateable.
Since:
1.10
Author:
Thomas Duellmann, Tobias Rudolph, Markus Fischer
  • Constructor Details

    • AbstractUpdateableFilterPlugin

      public AbstractUpdateableFilterPlugin​(Configuration configuration, IProjectContext projectContext)
      Deprecated.
      Each Plugin requires a constructor with a Configuration object and an IProjectContext.
      Parameters:
      configuration - The configuration for this component.
      projectContext - The project context for this component. The component will be registered.
  • Method Details

    • setCurrentConfiguration

      public abstract void setCurrentConfiguration​(Configuration config, boolean update)
      Deprecated.
      Set current configuration. Example implementation:
       // The following condition is true, if key exists in config object AND (update and isUpdateable is true OR update is false)
       if (!update || isPropertyUpdateable(CONFIG_PROPERTY_PROP_NAME)) {
              this.localProperty = config.getLongProperty(CONFIG_PROPERTY_PROP_NAME);
       }
       
      Parameters:
      config - Configuration object that contains the configuration to be set.
      update - If false, set all properties, else overwrite only properties that are marked as updateable
    • isPropertyUpdateable

      public boolean isPropertyUpdateable​(java.lang.String propertyName)
      Deprecated.
      Checks whether the property with the given name is marked as updateable.
      Parameters:
      propertyName - Name of the property to check
      Returns:
      true if marked as updateable, else false.