Package org.java.plugin.registry

Interface ExtensionPoint

    • Method Detail

      • getParameterDefinition

        ExtensionPoint.ParameterDefinition getParameterDefinition​(java.lang.String id)
        Parameters:
        id - ID of parameter definition to look for
        Returns:
        parameter definition with given ID

      • getAvailableExtensions

        java.util.Collection<Extension> getAvailableExtensions()
        Returns a collection of all extensions that available for this point.
        Returns:
        collection of Extension objects

      • getAvailableExtension

        Extension getAvailableExtension​(java.lang.String uniqueId)
        Parameters:
        uniqueId - unique ID of extension
        Returns:
        extension that is available for this point

      • isExtensionAvailable

        boolean isExtensionAvailable​(java.lang.String uniqueId)
        Checks if extension is available for this extension point. If this method returns true, the method getAvailableExtension(String) should return valid extension for the same UID.
        Parameters:
        uniqueId - unique ID of extension
        Returns:
        true if extension is available for this extension point

      • getConnectedExtensions

        java.util.Collection<Extension> getConnectedExtensions()
        Returns a collection of all extensions that was successfully "connected" to this point.
        Returns:
        collection of Extension objects

      • getConnectedExtension

        Extension getConnectedExtension​(java.lang.String uniqueId)
        Parameters:
        uniqueId - unique ID of extension
        Returns:
        extension that was successfully "connected" to this point

      • isExtensionConnected

        boolean isExtensionConnected​(java.lang.String uniqueId)
        Checks if extension is in valid state and successfully "connected" to this extension point. If this method returns true, the method getConnectedExtension(String) should return valid extension for the same UID.
        Parameters:
        uniqueId - unique ID of extension
        Returns:
        true if extension was successfully "connected" to this extension point

      • isValid

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

      • getParentPluginId

        java.lang.String getParentPluginId()
        Returns:
        parent extension point plug-in ID or null

      • getParentExtensionPointId

        java.lang.String getParentExtensionPointId()
        Returns:
        parent extension point ID or null

      • isSuccessorOf

        boolean isSuccessorOf​(ExtensionPoint extensionPoint)
        Parameters:
        extensionPoint - extension point
        Returns:
        true if this point is successor of given extension point

      • getDescendants

        java.util.Collection<ExtensionPoint> getDescendants()
        Looks for all available (valid) successors of this extension point. The search should be done recursively including all descendants of this extension point.
        Returns:
        collection of ExtensionPoint objects