notio
Class Extensions

java.lang.Object
  |
  +--notio.Extensions

public class Extensions
extends java.lang.Object

Class which may be queried to verify that specific, independant extensions to the API are available and also to activate or deactivate any extended features. Note that all methods in this class are static and specific instances of it are not needed.


Constructor Summary
Extensions()
           
 
Method Summary
static void activateExtension(java.lang.String extensionName, java.lang.Object[] args)
          Used to activate or configure API extensions.
static void deactivateExtension(java.lang.String extensionName, java.lang.Object[] args)
          Used to deactivate API extensions.
static java.lang.Object[] getExtensionParameters(java.lang.String extensionName)
          Used to query the current configuration of an extension.
static boolean isExtensionActive(java.lang.String extensionName)
          Used to check if a particular extension is 'active'.
static boolean isExtensionAvailable(java.lang.String extensionName)
          Used to check if a particular extension is available.
static java.lang.String[] listAvailableExtensions()
          Returns an array of strings that contains the names of all available extensions.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Extensions

public Extensions()
Method Detail

listAvailableExtensions

public static java.lang.String[] listAvailableExtensions()
Returns an array of strings that contains the names of all available extensions. Extension names should look something like: EXTENSION_THREAD_SAFETY
Returns:
an array of strings containing the names of available extensions, possibly empty, or null.

isExtensionAvailable

public static boolean isExtensionAvailable(java.lang.String extensionName)
Used to check if a particular extension is available.
Parameters:
extensionName - the extension being looked for.
Returns:
true if the extension is available.

isExtensionActive

public static boolean isExtensionActive(java.lang.String extensionName)
Used to check if a particular extension is 'active'. Not all extensions will have an active or inactive status. The results for calling this method for such extensions is undefined.
Parameters:
extensionName - the extension being looked for.
Returns:
true if the extension is active.

getExtensionParameters

public static java.lang.Object[] getExtensionParameters(java.lang.String extensionName)
Used to query the current configuration of an extension. Not all extensions will have configuration information. The result of calling this method for such extensions is undefined.
Parameters:
extensionName - the extension being looked for.
Returns:
an array of Objects containing the desired information, possibly empty, or null.

activateExtension

public static void activateExtension(java.lang.String extensionName,
                                     java.lang.Object[] args)
Used to activate or configure API extensions. Obviously, not all extensions will be optional or require configuration. If an extension does not require these services then the implementation can simply ignore calls to this method with regards to that extension.
Parameters:
extensionName - the extension being activated/configured
args - an array of objects used to configure the extension if necessary.

deactivateExtension

public static void deactivateExtension(java.lang.String extensionName,
                                       java.lang.Object[] args)
Used to deactivate API extensions. Obviously, not all extensions will be optional. If an extension does not require these services then the implementation can simply ignore calls to this method with regards to that extension. The arguments are provided for deactivation in case any details need to be specified about the deactivation process.
Parameters:
extensionName - the extension being activated/configured
args - an array of objects used to configure the extension if necessary.


Copyright 1998-2001 Finnegan Southey