Package org.faktorips.runtime.internal.toc

Interface ITocEntryFactory<T extends TocEntryObject>

All Known Implementing Classes:

AbstractTocEntryFactory, AbstractTocEntryFactory.EnumContentTocEntryFactory, AbstractTocEntryFactory.EnumXmlAdapterTocEntryFactory, AbstractTocEntryFactory.FormulaTestTocEntryFactory, AbstractTocEntryFactory.PolicyCmptTypeTocEntryFactory, AbstractTocEntryFactory.ProductCmptTocEntryFactory, AbstractTocEntryFactory.ProductCmptTypeTocEntryFactory, AbstractTocEntryFactory.TableContentTocEntryFactory, AbstractTocEntryFactory.TestCaseTocEntryFactory

public interface ITocEntryFactory<T extends TocEntryObject>

A ITocEntryFactory implementation is used to load TocEntryObjects of a given type identified by their XML tag.

To make a ITocEntryFactory available during design time, it has to be registered with the org.faktorips.devtools.stdbuilder.tocEntryFactory extension point.

At runtime, the extension point mechanism is not available, instead the ServiceLoader is used. For the ServiceLoader to find the implementation, the full qualified name of the implementation class must be specified in the file META-INF/services/org.faktorips.runtime.internal.toc.ITocEntryFactory.

The file and the implementation class must be accessible by the ClassLoader provided to the AbstractReadonlyTableOfContents's constructor.

Author:

schwering

Method Summary

Modifier and Type	Method	Description
T	createFromXml(Element entryElement)	Creates a TocEntryObject from it's XML representation.
String	getXmlTag()	Returns the XML tag identifying a TocEntryObject this factory can create.

Method Details

createFromXml

T createFromXml(Element entryElement)

Creates a TocEntryObject from it's XML representation.

Parameters:

entryElement - the XML element representing the TocEntryObject

Returns:

a TocEntryObject

getXmlTag

String getXmlTag()

Returns the XML tag identifying a TocEntryObject this factory can create.

Returns:

the XML tag identifying a TocEntryObject this factory can create