org.apache.hivemind.impl
Class AbstractExtensionPoint

java.lang.Object
  org.apache.hivemind.impl.BaseLocatable
      org.apache.hivemind.impl.AbstractExtensionPoint

All Implemented Interfaces:

ExtensionPoint, Locatable, LocationHolder

Direct Known Subclasses:

ConfigurationPointImpl, ServicePointImpl

public abstract class AbstractExtensionPoint
extends BaseLocatable
implements ExtensionPoint

Base class for extension points; provides module, visibility and extensionPointId properties.

Author:

Howard Lewis Ship

Constructor Summary

AbstractExtensionPoint()

Method Summary

protected abstract void	extendDescription(ToStringBuilder builder) Implemented in subclasses to provide details about subclass properties.
ErrorLog	getErrorLog() Returns an ErrorLog used to report any recoverable errors related to the extension point.
java.lang.String	getExtensionPointId() Returns the fully qualified id of the extension point.
org.apache.commons.logging.Log	getLog() Returns the Log instance for this extension point.
Module	getModule() Returns the Module containing the extension point.
void	setExtensionPointId(java.lang.String extensionPointId)
void	setModule(Module module)
void	setVisibility(Visibility visibility)
java.lang.String	toString()
boolean	visibleToModule(Module module) Returns true if the extension point is public, or the extgension point is visible to the module.

Methods inherited from class org.apache.hivemind.impl.BaseLocatable

getLocation, setLocation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.hivemind.Locatable

getLocation

Constructor Detail

AbstractExtensionPoint

public AbstractExtensionPoint()

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

extendDescription

protected abstract void extendDescription(ToStringBuilder builder)

Implemented in subclasses to provide details about subclass properties.

setExtensionPointId

public void setExtensionPointId(java.lang.String extensionPointId)

getExtensionPointId

public java.lang.String getExtensionPointId()

Description copied from interface: ExtensionPoint

Returns the fully qualified id of the extension point.

Specified by:

getExtensionPointId in interface ExtensionPoint

setModule

public void setModule(Module module)

getModule

public Module getModule()

Description copied from interface: ExtensionPoint

Returns the Module containing the extension point.

Specified by:

getModule in interface ExtensionPoint

setVisibility

public void setVisibility(Visibility visibility)

Since:

1.1

visibleToModule

public boolean visibleToModule(Module module)

Returns true if the extension point is public, or the extgension point is visible to the module.

Specified by:

visibleToModule in interface ExtensionPoint

Parameters:

module - The module to validate visibility against, or null for no module ... such as when the application accesses an extension via Registry.

Since:

1.1

getLog

public org.apache.commons.logging.Log getLog()

Description copied from interface: ExtensionPoint

Returns the Log instance for this extension point.

Specified by:

getLog in interface ExtensionPoint

Since:

1.1

getErrorLog

public ErrorLog getErrorLog()

Description copied from interface: ExtensionPoint

Returns an ErrorLog used to report any recoverable errors related to the extension point.

Specified by:

getErrorLog in interface ExtensionPoint

Since:

1.1