org.apache.hivemind.definition
Interface ConfigurationPointDefinition

All Superinterfaces:
ExtensionPointDefinition, Locatable
All Known Implementing Classes:
ConfigurationPointDefinitionImpl

public interface ConfigurationPointDefinition
extends ExtensionPointDefinition

Defines a configuration extension point. The definition includes the configuration type, contributions and parsers.

Author:
Achim Huegen

Method Summary
 void addContribution(ContributionDefinition contribution)
          Adds a contribution.
 void addParser(ConfigurationParserDefinition parser)
          Adds a parser definition.
 java.lang.String getConfigurationTypeName()
           
 java.util.Collection getContributions()
           
 Occurances getExpectedContributions()
           
 ConfigurationParserDefinition getParser(java.lang.String inputFormat)
          Returns the parsers which is responsible for processing the specified inputFormat.
 java.util.Collection getParsers()
           
 
Methods inherited from interface org.apache.hivemind.definition.ExtensionPointDefinition
getId, getModuleId, getQualifiedId, getVisibility
 
Methods inherited from interface org.apache.hivemind.Locatable
getLocation
 

Method Detail

getConfigurationTypeName

java.lang.String getConfigurationTypeName()
Returns:
the fully qualified class name of the configuration type

getExpectedContributions

Occurances getExpectedContributions()
Returns:
the expected number of contributions to this configuration point

getContributions

java.util.Collection getContributions()
Returns:
the contributions to this configuration as instances of ContributionDefinition

addContribution

void addContribution(ContributionDefinition contribution)
Adds a contribution.

Parameters:
contribution - the contribution
Throws:
ApplicationRuntimeException - if this point is not visible from the module that defines the contribution

addParser

void addParser(ConfigurationParserDefinition parser)
Adds a parser definition.

Parameters:
parser - the parser
Throws:
ApplicationRuntimeException - if this point is not visible from the module that defines the parser or if a parser for the specified format is already defined

getParser

ConfigurationParserDefinition getParser(java.lang.String inputFormat)
Returns the parsers which is responsible for processing the specified inputFormat.

Parameters:
inputFormat - the input format
Returns:
the parser

getParsers

java.util.Collection getParsers()
Returns:
returns all parsers as instances of ConfigurationParserDefinition


Copyright © 2003-2007 Apache Software Foundation. All Rights Reserved.