public interface TypedOutletSaxHandlerFactory
OutletSaxHandler
s for a specific outlet type.Modifier and Type | Method and Description |
---|---|
Outlet |
createOutletForTemplate(String templatePath,
ConfigurationProvider configurationProvider)
Creates an outlet for a template with the given file name.
|
OutletSaxHandler |
getOutletSaxHandler(QualifiedName outletName,
ConfigurationProvider configurationProvider,
UnitDescriptor unitDescriptor,
ConfigurationHandlers configurationHandlers)
Returns a OutletSaxHandler for reading in the configuration of
a outlet.
|
Collection<String> |
getTemplatesFilenameExtensionsForScan()
Returns the filename extensions for templates which define outlets
of this type.
|
String |
getType()
Returns the outlet type handled by the OutletSaxHandlers which are
created by this factory.
|
String getType()
Collection<String> getTemplatesFilenameExtensionsForScan()
Outlet createOutletForTemplate(String templatePath, ConfigurationProvider configurationProvider) throws ConfigurationException
templatePath
- the path to the template,
relative to the templates directory, not null.configurationProvider
- the configuration provider, not null.ConfigurationException
- if the outlet cannot be created.UnsupportedOperationException
- if the OutletSaxHandlerFactory
is not template based or cannot create outlets on file name
information alone.OutletSaxHandler getOutletSaxHandler(QualifiedName outletName, ConfigurationProvider configurationProvider, UnitDescriptor unitDescriptor, ConfigurationHandlers configurationHandlers) throws SAXException
outletName
- the name for the outlet which configuration
will be read in by the generated SaxHandlerFactory,
or null if the name of the outlet should be determined from
the parsed xml.configurationProvider
- The access object for the configuration
files, not null.unitDescriptor
- The description of the generation unit, not null.configurationHandlers
- the available configuration handlers,
not null.SAXException
- if the SAX Handler for the outlet can
not be created from the given XML element.Copyright © 2000–2020 The Apache Software Foundation. All rights reserved.