| org.mmbase.framework.Component
All known Subclasses: org.mmbase.framework.BasicComponent,
Component | public interface Component (Code) | | A component is a piece of pluggable functionality that typically has dependencies on other
components.
A Component bundles
Block s,
Action s and
@Setting .
author: Michiel Meeuwissen version: $Id: Component.java,v 1.19 2008/02/22 14:05:57 michiel Exp $ since: MMBase-1.9 |
configure | void configure(org.w3c.dom.Element element)(Code) | | Configures the component, by XML.
Parameters: element - A 'component' element from the 'components' XSD. |
getBlock | Block getBlock(String name)(Code) | | Gets a specific block. If there is no such block, then null is returned.
Parameters: name - The name of the block. If this parameter is null , then Component.getDefaultBlock canbe returned. |
getBlocks | Collection<Block> getBlocks()(Code) | | An unmodifiable collection of all blocks associated with the component
|
getDefaultBlock | Block getDefaultBlock()(Code) | | Gets the one block that is the 'default' block of this component
|
getDescription | LocalizedString getDescription()(Code) | | The description can contain further information about the component, mainly to be displayed
in pages about components generally.
|
getName | String getName()(Code) | | Every component has a (universally) unique name
|
getSettings | Collection<Setting<?>> getSettings()(Code) | | An unmodifiable collection of all settings associated with this component
|
getUnsatisfiedDependencies | Collection<VirtualComponent> getUnsatisfiedDependencies()(Code) | | The unsatisfied dependencies, so this should return an empty collection. Unless the framework
is still initializing, because initially dependencies can be temporary added as 'unsatisfied'
because perhaps this other component is simply not yet loaded. The
ComponentRepository will call
Component.resolve(VirtualComponent,Component) when a
dependency is satisfied after all.
|
getUri | URI getUri()(Code) | | An URI which may identify the configuration of this Component.
|
getVersion | int getVersion()(Code) | | A component has a version number.
|
|
|