public interface ExtensionPoint extends UniqueIdentity, PluginElement<ExtensionPoint>
Extension point UID is a combination of declaring plug-in ID and extension point ID that is unique within whole set of registered plug-ins.
Modifier and Type | Interface and Description |
---|---|
static interface |
ExtensionPoint.ParameterDefinition
This interface abstracts parameter definition - a parameter
"type declaration".
|
Modifier and Type | Method and Description |
---|---|
Extension |
getAvailableExtension(String uniqueId) |
Collection<Extension> |
getAvailableExtensions()
Returns a collection of all extensions that available for this point.
|
Extension |
getConnectedExtension(String uniqueId) |
Collection<Extension> |
getConnectedExtensions()
Returns a collection of all extensions that was successfully "connected"
to this point.
|
Collection<ExtensionPoint> |
getDescendants()
Looks for all available (valid) successors of this extension point.
|
ExtensionMultiplicity |
getMultiplicity() |
ExtensionPoint.ParameterDefinition |
getParameterDefinition(String id) |
Collection<ExtensionPoint.ParameterDefinition> |
getParameterDefinitions()
Returns collection of all top level parameter definitions declared
in this extension point and all it parents.
|
String |
getParentExtensionPointId() |
String |
getParentPluginId() |
boolean |
isExtensionAvailable(String uniqueId)
Checks if extension is available for this extension point.
|
boolean |
isExtensionConnected(String uniqueId)
Checks if extension is in valid state and successfully "connected"
to this extension point.
|
boolean |
isSuccessorOf(ExtensionPoint extensionPoint) |
boolean |
isValid() |
getUniqueId
getDeclaringPluginDescriptor, getDeclaringPluginFragment
getDocsPath, getDocumentation
ExtensionMultiplicity getMultiplicity()
Collection<ExtensionPoint.ParameterDefinition> getParameterDefinitions()
ExtensionPoint.ParameterDefinition
objectsExtensionPoint.ParameterDefinition getParameterDefinition(String id)
id
- ID of parameter definition to look forCollection<Extension> getAvailableExtensions()
Extension
objectsExtension getAvailableExtension(String uniqueId)
uniqueId
- unique ID of extensionboolean isExtensionAvailable(String uniqueId)
true
, the method
getAvailableExtension(String)
should return valid extension for
the same UID.uniqueId
- unique ID of extensiontrue
if extension is available for this extension
pointCollection<Extension> getConnectedExtensions()
Extension
objectsExtension getConnectedExtension(String uniqueId)
uniqueId
- unique ID of extensionboolean isExtensionConnected(String uniqueId)
true
,
the method getConnectedExtension(String)
should return
valid extension for the same UID.uniqueId
- unique ID of extensiontrue
if extension was successfully "connected" to
this extension pointboolean isValid()
true
if extension point is considered to be validString getParentPluginId()
null
String getParentExtensionPointId()
null
boolean isSuccessorOf(ExtensionPoint extensionPoint)
extensionPoint
- extension pointtrue
if this point is successor of given extension
pointCollection<ExtensionPoint> getDescendants()
ExtensionPoint
objectsCopyright © 2016. All rights reserved.