Fork me
BeyondAR
Augmented Reality Framework for Android
 All Classes Functions Variables
com.beyondar.android.plugin.Plugable< T extends Plugin > Interface Reference

Interface to define which Classes can be extended using plugins. More...

Public Member Functions

void addPlugin (T plugin)
 Add a new plugin. More...
 
boolean removePlugin (T pluginClass)
 Remove an specific plugin. More...
 
void removeAllPlugins ()
 Clean all the plugin's.
 
getFirstPlugin (Class<?extends T > pluginClass)
 
boolean containsAnyPlugin (Class<?extends T > pluginClass)
 Test whether any plugin class exist. More...
 
boolean containsPlugin (T plugin)
 Test whether the plugin exist. More...
 
List< T > getAllPlugins (Class<?extends T > pluginClass, List< T > result)
 Get all plugin's which implemented a specific class. More...
 
List< T > getAllPugins (Class<?extends T > pluginClass)
 Get all plugin's which implement an specific class. More...
 
List< T > getAllPlugins ()
 Get a List copy of the added plugin's. More...
 

Static Public Attributes

static int DEFAULT_PLUGINS_CAPACITY = 3
 Recommended initial size of the list that contains all the loade plugins.
 

Detailed Description

Interface to define which Classes can be extended using plugins.

Parameters
<T>The type of plugin that the class can handle.

Member Function Documentation

void com.beyondar.android.plugin.Plugable< T extends Plugin >.addPlugin ( plugin)

Add a new plugin.

This plugin's will be initialize ones is added

Parameters
plugin
boolean com.beyondar.android.plugin.Plugable< T extends Plugin >.containsAnyPlugin ( Class<?extends T >  pluginClass)

Test whether any plugin class exist.

Parameters
pluginClass
Returns
true if there is any plugin, false otherwise
boolean com.beyondar.android.plugin.Plugable< T extends Plugin >.containsPlugin ( plugin)

Test whether the plugin exist.

Parameters
plugin
Returns
true if there is any plugin, false otherwise
List<T> com.beyondar.android.plugin.Plugable< T extends Plugin >.getAllPlugins ( Class<?extends T >  pluginClass,
List< T >  result 
)

Get all plugin's which implemented a specific class.

Parameters
pluginClassThe specific class that we want to retrieve
resultA list where all the plugins will be stored
Returns
List<T> com.beyondar.android.plugin.Plugable< T extends Plugin >.getAllPlugins ( )

Get a List copy of the added plugin's.

Adding/removing plugin's to this list will not affect the added plugin's

Returns
List<T> com.beyondar.android.plugin.Plugable< T extends Plugin >.getAllPugins ( Class<?extends T >  pluginClass)

Get all plugin's which implement an specific class.

Parameters
pluginClassThe specific class that we want to retrieve
Returns
boolean com.beyondar.android.plugin.Plugable< T extends Plugin >.removePlugin ( pluginClass)

Remove an specific plugin.

Parameters
pluginClass
Returns
true if it has been removed

The documentation for this interface was generated from the following file: