JPF 0.10

org.java.plugin.registry
Interface Extension

All Superinterfaces:
Documentable, Identity, PluginElement, UniqueIdentity

public interface Extension
extends UniqueIdentity, PluginElement

This interface abstracts an extension - particular functionality, the plug-in contribute to the system.

Extension UID is a combination of declaring plug-in ID and extension ID that is unique within whole set of registered plug-ins.

Version:
$Id: Extension.java,v 1.2 2005/12/10 13:15:28 ddimon Exp $

Nested Class Summary
static interface Extension.Parameter
          This interface abstracts extension parameter according to extension declaration in manifest.
 
Method Summary
 java.lang.String getExtendedPluginId()
           
 java.lang.String getExtendedPointId()
           
 Extension.Parameter getParameter(java.lang.String id)
          Returns top level parameter with given ID or null if no top level parameters exist.
 java.util.Collection getParameters()
          Returns collection of all top level parameters defined in this extension.
 java.util.Collection getParameters(java.lang.String id)
           
 boolean isValid()
           
 
Methods inherited from interface org.java.plugin.registry.UniqueIdentity
getUniqueId
 
Methods inherited from interface org.java.plugin.registry.Identity
getId
 
Methods inherited from interface org.java.plugin.registry.PluginElement
getDeclaringPluginDescriptor, getDeclaringPluginFragment
 
Methods inherited from interface org.java.plugin.registry.Documentable
getDocsPath, getDocumentation
 

Method Detail

getParameters

public java.util.Collection getParameters()
Returns collection of all top level parameters defined in this extension.

Returns:
collection of Extension.Parameter objects

getParameter

public Extension.Parameter getParameter(java.lang.String id)
Returns top level parameter with given ID or null if no top level parameters exist. If more than one top level parameters with given ID found, the method should throw an IllegalArgumentException.

Parameters:
id - ID of parameter to look for
Returns:
top level parameter with given ID

getParameters

public java.util.Collection getParameters(java.lang.String id)
Parameters:
id - ID of parameter to look for
Returns:
collection of all top level parameters with given ID

getExtendedPluginId

public java.lang.String getExtendedPluginId()
Returns:
ID of plug-in, extended point belongs to

getExtendedPointId

public java.lang.String getExtendedPointId()
Returns:
ID of extended point

isValid

public boolean isValid()
Returns:
true if extension is considered to be valid

JPF 0.10

Copyright © 2004-2005 Dmitry Olshansky. All Rights Reserved.