Framework

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> com >> virtuosotechnologies >> lib >> [ plugin overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of com.virtuosotechnologies.lib.plugin.Framework

SOURCE |

Download com.virtuosotechnologies.lib.plugin.Framework

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.virtuosotechnologies.lib.plugin
Interface Framework

All Known Implementing Classes:: MainFrameworkImpl

public interface Framework

The framework entry point

Field Summary

static APIVersion CURRENT_FRAMEWORK_APIVERSION


static java.lang.String FRAMEWORK_APINAME


Method Summary

void addFrameworkListener(FrameworkListener listener)
          Register a listener on the Framework.

java.util.Set getAvailableAPINames()
          Get the names of the currently available APIs as a snapshot Set.

java.util.Set getAvailableAPIVersions(java.lang.String name)
          Get the currently available versions of the given API name, as a snapshot Set.

java.util.Set getCurrentPluginNames()
          Get the names of the currently available plugins as a snapshot Set.

java.lang.String getPluginDescription(java.lang.String plugin)
          Get the description for the given plugin.

java.lang.String getProvidingPluginFor(java.lang.String name, APIVersion version)
          Get the name of the plugin that provides the given API and version.

void plug(java.util.Collection info)
          Attempt to plug in the given Plugins.

APIProvider provideAPI(java.lang.String name, APIVersion version, java.lang.String description, java.lang.Object impl)
          Register an API with no providing plugin.

void removeFrameworkListener(FrameworkListener listener)
          Remove a listener on the Framework.

Field Detail

FRAMEWORK_APINAME

public static final java.lang.String FRAMEWORK_APINAME

See Also:: Constant Field Values

CURRENT_FRAMEWORK_APIVERSION

public static final APIVersion CURRENT_FRAMEWORK_APIVERSION

Method Detail

getCurrentPluginNames

public java.util.Set getCurrentPluginNames()

Get the names of the currently available plugins as a snapshot Set.

getPluginDescription

public java.lang.String getPluginDescription(java.lang.String plugin)

Get the description for the given plugin. Returns null if the plugin name is not present.

getAvailableAPINames

public java.util.Set getAvailableAPINames()

Get the names of the currently available APIs as a snapshot Set.

getAvailableAPIVersions

public java.util.Set getAvailableAPIVersions(java.lang.String name)

Get the currently available versions of the given API name, as a snapshot Set.

getProvidingPluginFor

public java.lang.String getProvidingPluginFor(java.lang.String name,
                                              APIVersion version)
                                       throws APINotAvailableException

Get the name of the plugin that provides the given API and version. You need to specify the exact API version.

plug

public void plug(java.util.Collection info)
          throws PluginException

Attempt to plug in the given Plugins.

provideAPI

public APIProvider provideAPI(java.lang.String name,
                              APIVersion version,
                              java.lang.String description,
                              java.lang.Object impl)
                       throws DuplicateAPIException

addFrameworkListener

public void addFrameworkListener(FrameworkListener listener)

removeFrameworkListener

public void removeFrameworkListener(FrameworkListener listener)

Remove a listener on the Framework.