net.sourceforge.blogentis.plugins
Interface IExtensionPoint

All Known Subinterfaces:

IBlogExtensionPoint, ICommentExtensionPoint, INavigationExtensionPoint, IPageExtensionPoint, IPostEditExtensionPoint, IPostViewExtensionPoint, IRPCExtensionPoint, IStorageExtensionPoint

All Known Implementing Classes:

AbstractBlogExtensionPoint, AbstractExtensionPoint, CommentExtensionPointImpl, NavigationExtensionPointImpl, PageExtensionPointImpl, PostEditExtensionPointImpl, PostViewExtensionPointImpl, StorageExtensionPointImpl, XmlRpcExtensionPoint

public interface IExtensionPoint

Interface for extension points. No actual functionality is defined here, it is expected to be provided by the implementors of this interface.

Author:

abas

Method Summary

void	addExtension(IExtension extension) Add an extension to this extension point.
java.lang.Class	getExtensionClass() Get the class or interface that extensions for this extension point have to implement.
java.util.Iterator	getExtensions() Get the list of extensions that have been registered with this extension point.
java.lang.String	getName() Get the user-visible name of this extension point.
IPlugin	getPlugin() Get the plugin that defines this extension point.
void	removeExtension(IExtension extension) Remove an extension from this extension point.
void	removeExtensions(IPlugin plugin) Remove all extensions that belong to this plugin.

Method Detail

getName

public java.lang.String getName()

Get the user-visible name of this extension point.

Returns:

the name of this extension point.

getPlugin

public IPlugin getPlugin()

Get the plugin that defines this extension point.

Returns:

The plugin that defines this extension.

getExtensionClass

public java.lang.Class getExtensionClass()

Get the class or interface that extensions for this extension point have to implement.

Returns:

this extension points' appropriate base class or inteface.

addExtension

public void addExtension(IExtension extension)

Add an extension to this extension point.

Parameters:

extension - the extension to add.

removeExtension

public void removeExtension(IExtension extension)

Remove an extension from this extension point.

Parameters:

extension - the extension to remove.

removeExtensions

public void removeExtensions(IPlugin plugin)

Remove all extensions that belong to this plugin.

Parameters:

plugin - the plugin whose extensions should be removed.

getExtensions

public java.util.Iterator getExtensions()

Get the list of extensions that have been registered with this extension point. Depending on the extension point, order may be significant.

Returns:

the list of extensions.