org.bladerunnerjs.api.plugin.base

Class AbstractPlugin

java.lang.Object

org.bladerunnerjs.api.plugin.base.AbstractPlugin

All Implemented Interfaces:

Plugin

Direct Known Subclasses:

AbstractAssetPlugin, AbstractCommandPlugin, AbstractContentPlugin, AbstractMinifierPlugin, AbstractModelObserverPlugin, AbstractRequirePlugin, AbstractTagHandlerPlugin

public abstract class AbstractPlugin
extends java.lang.Object
implements Plugin

The AbstractPlugin class is used to provide common implementations of the plug-in methods needed to overcome the issues caused by the use of virtual proxy wrappers (see Plugin for more details). Since this class is abstract, developers will need to extend one of this classes sub-classes to make use of this functionality.

Constructor Summary

Constructors

Constructor and Description
AbstractPlugin()

Method Summary

Modifier and Type	Method and Description
<P extends Plugin> P	castTo(java.lang.Class<P> pluginInterface) An alternative to Java's class casting mechanism that is needed because BladeRunnerJS wraps plug-ins within virtual proxy wrappers, preventing class casting from working.
void	close() Invoked during the invocation of BRJS.close(), offering plug-ins a chance to release any resources they may be holding on to.
boolean	equals(java.lang.Object otherPlugin)
java.lang.Class<?>	getPluginClass() An alternative to Java's Object.getClass() method that is needed because BladeRunnerJS wraps plug-ins within virtual proxy wrappers, causing the native Object.getClass() method to become ineffective.
<P extends Plugin> boolean	instanceOf(java.lang.Class<P> pluginInterface) An alternative to Java's instanceof operator that is needed because BladeRunnerJS wraps plug-ins within virtual proxy wrappers, causing the native instanceof operator to become ineffective.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.bladerunnerjs.api.plugin.Plugin

setBRJS

Constructor Detail

AbstractPlugin

public AbstractPlugin()

Method Detail

equals

public boolean equals(java.lang.Object otherPlugin)

Overrides:

equals in class java.lang.Object

close

public void close()

Description copied from interface: Plugin

Invoked during the invocation of BRJS.close(), offering plug-ins a chance to release any resources they may be holding on to.

Specified by:

close in interface Plugin

instanceOf

public <P extends Plugin> boolean instanceOf(java.lang.Class<P> pluginInterface)

Description copied from interface: Plugin

An alternative to Java's instanceof operator that is needed because BladeRunnerJS wraps plug-ins within virtual proxy wrappers, causing the native instanceof operator to become ineffective.

Plug-ins are not expected to implement this method themselves, and should instead extend one of the AbstractPlugin sub-classes (e.g. AbstractCommandPlugin).

Specified by:

instanceOf in interface Plugin

Type Parameters:

P - Any plugin

Parameters:

pluginInterface - The interface which this object may, or may not be, an instance of.

Returns:

true, if this object is an instance of the given interface, and false otherwise.

castTo

public <P extends Plugin> P castTo(java.lang.Class<P> pluginInterface)

Description copied from interface: Plugin

An alternative to Java's class casting mechanism that is needed because BladeRunnerJS wraps plug-ins within virtual proxy wrappers, preventing class casting from working.

Plug-ins are not expected to implement this method themselves, and should instead extend one of the AbstractPlugin sub-classes (e.g. AbstractCommandPlugin).

Specified by:

castTo in interface Plugin

Type Parameters:

P - Any plugin

Parameters:

pluginInterface - The interface which this object may, or may not be, an instance of.

Returns:

The plugin cast to the type P

getPluginClass

public java.lang.Class<?> getPluginClass()

Description copied from interface: Plugin

An alternative to Java's Object.getClass() method that is needed because BladeRunnerJS wraps plug-ins within virtual proxy wrappers, causing the native Object.getClass() method to become ineffective.

Plug-ins are not expected to implement this method themselves, and should instead extend one of the AbstractPlugin sub-classes (e.g. AbstractCommandPlugin).

Specified by:

getPluginClass in interface Plugin

Returns:

A reference to the class of the underlying plug-in.