com.robopupu.api.plugin

Class PluginBus

java.lang.Object

com.robopupu.api.plugin.PluginBus

public class PluginBus
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
static void	addPlugInvoker(java.lang.Class<?> plugInterface, PlugInvoker<?> plugInvoker)
static boolean	canInvoke(java.lang.Object target) Test if a method can be invoked on the given target Object.
protected <T> java.util.List<T>	doGetPlugs(java.lang.Class<T> plugInterface, boolean includeExtendedInterfaces)
static PluginBus	getInstance()
static <T> T	getPlug(java.lang.Class<?> plugInterface)
static <T> T	getPluggedObject(java.lang.Object plug) Gets the Object that is attached to given plug.
static java.util.List<PluginComponent>	getPluginComponents()
static <T> java.util.List<T>	getPlugins(java.lang.Class<T> plugInterface) Gets the plugins having exactly the specified plug interface.
static <T extends PlugInvoker<?>> T	getPlugInvoker(java.lang.Class<?> plugInterface)
static <T> java.util.List<T>	getPlugs(java.lang.Class<T> plugInterface) Gets the plugs (i.e.
static <T> java.util.List<T>	getPlugs(java.lang.Class<T> plugInterface, boolean includeExtendedInterfaces) Gets the plugs (i.e.
static boolean	hasPlug(java.lang.Class<?> plugInterface)
static boolean	hasPlugInvoker(java.lang.Class<?> plugInterface)
static void	injectPlugs(java.lang.Object plugin)
static void	injectPlugs(java.lang.Object plugin, boolean useHandler)
static boolean	isPlugged(java.lang.Object object) Tests if the given Object is currently plugged as a plugin into this PluginBus.
static boolean	isPlugin(java.lang.Class<?> pluginClass) Tests if the specified class represents a plugin object.
static <T> T	plug(java.lang.Class<?> pluginClass) Plugs an instance of specific Class to this PluginBus.
static <T> T	plug(java.lang.Class<?> pluginClass, DependencyScope scope) Plugs an instance of specific Class to this PluginBus.
static void	plug(java.util.List<java.lang.Object> plugins) Plugs the the given plugin Objects to this PluginBus.
static void	plug(java.lang.Object... plugins) Plugs the the given plugin Objects to this PluginBus.
static void	plug(java.lang.Object plugin) Plugs the the given plugin Object to this PluginBus.
static void	plug(java.lang.Object plugin, boolean useHandler)
void	plug(java.lang.Object plugin, java.lang.Class<?> plugInterface, PlugInvoker<?> plugInvoker, HandlerInvoker<?> handlerInvoker) This framework method should not be used by developers directly.
static void	unplug(java.lang.Object plugin)

Methods inherited from class java.lang.Object

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

Method Detail

getPlugins

public static <T> java.util.List<T> getPlugins(java.lang.Class<T> plugInterface)

Gets the plugins having exactly the specified plug interface.

Parameters:

plugInterface - A Class specifying the plug interface.

Returns:

A List containing the plugins.

getPlugs

public static <T> java.util.List<T> getPlugs(java.lang.Class<T> plugInterface)

Gets the plugs (i.e. PlugInvokers) having exactly the specified plug interface. Extended interfaces are included.

Parameters:

plugInterface - A Class specifying the plug interface.

Returns:

A List containing the plugs (i.e. PlugInvokers) .

getPlugs

public static <T> java.util.List<T> getPlugs(java.lang.Class<T> plugInterface,
                                             boolean includeExtendedInterfaces)

Gets the plugs (i.e. PlugInvokers) having exactly the specified plug interface.

Parameters:

plugInterface - A Class specifying the plug interface.

includeExtendedInterfaces - A boolean flag specifying if the extended interfaces are included.

Returns:

A List containing the plugs (i.e. PlugInvokers) .

doGetPlugs

protected <T> java.util.List<T> doGetPlugs(java.lang.Class<T> plugInterface,
                                           boolean includeExtendedInterfaces)

getPlug

public static <T> T getPlug(java.lang.Class<?> plugInterface)

hasPlug

public static boolean hasPlug(java.lang.Class<?> plugInterface)

getPluginComponents

public static java.util.List<PluginComponent> getPluginComponents()

getInstance

public static PluginBus getInstance()

addPlugInvoker

public static void addPlugInvoker(java.lang.Class<?> plugInterface,
                                  PlugInvoker<?> plugInvoker)

hasPlugInvoker

public static boolean hasPlugInvoker(java.lang.Class<?> plugInterface)

getPlugInvoker

public static <T extends PlugInvoker<?>> T getPlugInvoker(java.lang.Class<?> plugInterface)

plug

public static <T> T plug(java.lang.Class<?> pluginClass)

Plugs an instance of specific Class to this PluginBus.

Parameters:

pluginClass - A Class

Returns:

The plugged instance as an Object

plug

public static <T> T plug(java.lang.Class<?> pluginClass,
                         DependencyScope scope)

Plugs an instance of specific Class to this PluginBus. The instance is obtained using the given DependencyScope.

Parameters:

pluginClass - A Class

scope - A DependencyScope.

Returns:

The plugged instance as an Object

plug

public static void plug(java.lang.Object plugin)

Plugs the the given plugin Object to this PluginBus.

Parameters:

plugin - A plugin Object.

plug

public static void plug(java.lang.Object... plugins)

Plugs the the given plugin Objects to this PluginBus.

Parameters:

plugins - A variable length list plugin Objects.

plug

public static void plug(java.util.List<java.lang.Object> plugins)

Plugs the the given plugin Objects to this PluginBus.

Parameters:

plugins - A List containing the plugin Objects to be plugged.

plug

public static void plug(java.lang.Object plugin,
                        boolean useHandler)

injectPlugs

public static void injectPlugs(java.lang.Object plugin)

injectPlugs

public static void injectPlugs(java.lang.Object plugin,
                               boolean useHandler)

plug

public void plug(java.lang.Object plugin,
                 java.lang.Class<?> plugInterface,
                 PlugInvoker<?> plugInvoker,
                 HandlerInvoker<?> handlerInvoker)

This framework method should not be used by developers directly.

Parameters:

plugin - The plugin to be plugged as an Object.

plugInterface - A Class specifying the plugin interface type.

plugInvoker - A PlugInvoker instance. May be null if an instance of needed type of PlugInvoker is already cached in this PluginBus.

handlerInvoker - A HandlerInvoker instance. May be null if there is no needed for synchronising invocations with the main thread.

unplug

public static void unplug(java.lang.Object plugin)

isPlugged

public static boolean isPlugged(java.lang.Object object)

Tests if the given Object is currently plugged as a plugin into this PluginBus.

Parameters:

object - An Object.

Returns:

A boolean value.

canInvoke

public static boolean canInvoke(java.lang.Object target)

Test if a method can be invoked on the given target Object. The target may not be null, and in case of PlugInvoker it has to contain plugins.

Parameters:

target - An Object.

Returns:

A boolean value.

isPlugin

public static boolean isPlugin(java.lang.Class<?> pluginClass)

Tests if the specified class represents a plugin object.

Parameters:

pluginClass - A Class.

Returns:

A boolean value.

getPluggedObject

public static <T> T getPluggedObject(java.lang.Object plug)

Gets the Object that is attached to given plug.

Parameters:

plug - A plug as an Object

Returns:

An Object.