com.velasolaris.plugin.controller.spi

Class AbstractControllerPlugin

java.lang.Object

com.velasolaris.plugin.controller.spi.AbstractControllerPlugin

All Implemented Interfaces:

com.velasolaris.plugin.controller.spi.ControllerPlugin

Direct Known Subclasses:

ForteActorSensorPlugin

public abstract class AbstractControllerPlugin
extends java.lang.Object
implements com.velasolaris.plugin.controller.spi.ControllerPlugin

Abstract ControllerPlugin class. Concrete controller plugins should inherit from this class instead of directly from the ControllerPlugin interface.

Since:

Polysun 9.1

Author:

rkurmann

Field Summary

Fields inherited from interface com.velasolaris.plugin.controller.spi.ControllerPlugin

PLUGIN_CONTROLLER_INTERFACE_VERSION

Constructor Summary

Constructors

Constructor and Description
AbstractControllerPlugin()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() The human readable name of the controller plugin controller.
int	getSupportedInterfaceVersion(java.util.Map<java.lang.String,java.lang.Object> parameters) Returns the supported plugin controller interface version.
java.lang.String	getVersion() The version of this controller plugin.
boolean	isEnabled(java.util.Map<java.lang.String,java.lang.Object> aParameters) Is this controller plugin enabled?
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.velasolaris.plugin.controller.spi.ControllerPlugin

getControllers, getCreator, getDescription

Constructor Detail

AbstractControllerPlugin

public AbstractControllerPlugin()

Method Detail

getName

public java.lang.String getName()

Description copied from interface: com.velasolaris.plugin.controller.spi.ControllerPlugin

The human readable name of the controller plugin controller. E.g. "FlowrateControllerPlugin". This method is called if the name of the plugin controller is required.

Specified by:

getName in interface com.velasolaris.plugin.controller.spi.ControllerPlugin

Returns:

Short name, must not null

getVersion

public java.lang.String getVersion()

Description copied from interface: com.velasolaris.plugin.controller.spi.ControllerPlugin

The version of this controller plugin. E.g. "1.0". This method is called if the version is required.

Specified by:

getVersion in interface com.velasolaris.plugin.controller.spi.ControllerPlugin

Returns:

Plain text (semantic versioning suggested) or null if there is no version

isEnabled

public boolean isEnabled(java.util.Map<java.lang.String,java.lang.Object> aParameters)

Description copied from interface: com.velasolaris.plugin.controller.spi.ControllerPlugin

Is this controller plugin enabled?

Specified by:

isEnabled in interface com.velasolaris.plugin.controller.spi.ControllerPlugin

Parameters:

aParameters - Generic parameters

Returns:

true if enabled, otherwise false

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getSupportedInterfaceVersion

public int getSupportedInterfaceVersion(java.util.Map<java.lang.String,java.lang.Object> parameters)

Description copied from interface: com.velasolaris.plugin.controller.spi.ControllerPlugin

Returns the supported plugin controller interface version. Incrementing integer for each incompatible interface change.

Specified by:

getSupportedInterfaceVersion in interface com.velasolaris.plugin.controller.spi.ControllerPlugin

Parameters:

parameters - Generic parameters

Returns:

1 for Polysun 9.1 interface version