Package com.pnfsoftware.jeb.core.units

Class AbstractUnitPlugin

java.lang.Object
com.pnfsoftware.jeb.core.AbstractPlugin
com.pnfsoftware.jeb.core.units.AbstractUnitPlugin
All Implemented Interfaces:
IPlugin, IUnitPlugin
Direct Known Subclasses:
AbstractNativePlugin
public abstract class AbstractUnitPlugin extends AbstractPlugin implements IUnitPlugin
Skeleton implementation.

  • Field Details

  • Constructor Details

    • AbstractUnitPlugin

      public AbstractUnitPlugin(String type, double priority)
      Create a new native code plugin.
      Parameters:
      type - mandatory type, which will be used as the sub-region type when the identifier is initialized. The type should be a valid region name, please see PropertyDefinitionManager
      priority - mandatory priority

  • Method Details

    • initialize

      public void initialize(IPropertyDefinitionManager parentPdm)
      Description copied from interface: IUnitPlugin
      Create and initialize the property manager for this identifier. This method is usually called after construction on the identifier.

      Overrides are allowed if a plugin needs to define its own properties, but a call to the superclass method should take place first. If not, the implementor is responsible for creating the plugins' PDM.

      Specified by:
      initialize in interface IUnitPlugin
      Parameters:
      parentPdm - the parent PDM

    • getPropertyDefinitionManager

      public IPropertyDefinitionManager getPropertyDefinitionManager()
      Description copied from interface: IUnitPlugin
      Retrieve the property definition manager (PDM) used by this plugin.
      Specified by:
      getPropertyDefinitionManager in interface IUnitPlugin
      Returns:
      the PDM

    • getFormatType

      public String getFormatType()
      Description copied from interface: IUnitPlugin
      Retrieve the identity of the unit type. The type should be unique across all units.
      Specified by:
      getFormatType in interface IUnitPlugin
      Returns:
      the non-null type

    • getPriority

      public double getPriority()
      Description copied from interface: IUnitPlugin
      Get the identifier priority. Priority can be negative. Priorities are used by identifier managers (eg, Processors) to ensure that identifiers are called in a (partially) predictable order, if need be. The higher the number, the higher the priority.

      Recommendation: typical priority is zero. Relying on priority for proper identification should be used as a last resort measure.

      Specified by:
      getPriority in interface IUnitPlugin
      Returns:
      the identifier priority

    • getTypeIdProvider

      public ITypeIdProvider getTypeIdProvider()
      Description copied from interface: IUnitPlugin
      The type-id provider for this type of units. Currently, This method is not intended to use by third-party clients.
      Specified by:
      getTypeIdProvider in interface IUnitPlugin
      Returns:
      a type-id provider, null if none