Package org.apache.torque.generator.configuration.outlet

# Klasse JavaOutletSaxHandlerFactory

java.lang.Object
org.apache.torque.generator.configuration.outlet.JavaOutletSaxHandlerFactory

Alle implementierten Schnittstellen:
  `TypedOutletSaxHandlerFactory`

public class JavaOutletSaxHandlerFactory extends Object implements TypedOutletSaxHandlerFactory
Creates Java outlet SAX handlers.

- ## Konstruktorübersicht

  Konstruktoren
  Konstruktor
  Beschreibung
  `JavaOutletSaxHandlerFactory()`

- ## Methodenübersicht

  Modifizierer und Typ
  Methode
  Beschreibung
  `Outlet`
  `createOutletForTemplate(String templatePath, ConfigurationProvider configurationProvider)`
  Creates an outlet for a template with the given file name.
  `final OutletSaxHandler`
  `getOutletSaxHandler(QualifiedName outletName, ConfigurationProvider configurationProvider, UnitDescriptor unitDescriptor, ConfigurationHandlers configurationHandlers)`
  Returns a JavaOutletSaxHandler for reading the configuration of Java outlets.
  `Collection<String>`
  `getTemplatesFilenameExtensionsForScan()`
  Returns the filename extensions for templates which define outlets of this type.
  `String`
  `getType()`
  Returns the outlet type which can be handled by the OutletSaxHandlers created by this factory.

  ### Von Klasse geerbte Methoden java.lang.Object

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

- ## Konstruktordetails

  - ### JavaOutletSaxHandlerFactory

    public JavaOutletSaxHandlerFactory()

- ## Methodendetails

  - ### getType

    public String getType()
    Returns the outlet type which can be handled by the OutletSaxHandlers created by this factory.
    Angegeben von:
      `getType` in Schnittstelle `TypedOutletSaxHandlerFactory`
    Gibt zurück:
      "javaOutlet".

  - ### getTemplatesFilenameExtensionsForScan

    public Collection<String> getTemplatesFilenameExtensionsForScan()
    Returns the filename extensions for templates which define outlets of this type. These extensions are used for scanning the templates tree.
    Angegeben von:
      `getTemplatesFilenameExtensionsForScan` in Schnittstelle `TypedOutletSaxHandlerFactory`
    Gibt zurück:
      the empty list, as this outlet type is not described by templates.

  - ### createOutletForTemplate

    public Outlet createOutletForTemplate(String templatePath, ConfigurationProvider configurationProvider)
    Creates an outlet for a template with the given file name. This implementation throws a UnsupportedOperationException as java outlets are not template based.
    Angegeben von:
      `createOutletForTemplate` in Schnittstelle `TypedOutletSaxHandlerFactory`
    Parameter:
      `templatePath` - the path to the template, relative to the templates directory, not null.
      `configurationProvider` - the configuration provider.
    Gibt zurück:
      always throws an Exception
    Löst aus:
      `UnsupportedOperationException` - always.

  - ### getOutletSaxHandler

    public final OutletSaxHandler getOutletSaxHandler(QualifiedName outletName, ConfigurationProvider configurationProvider, UnitDescriptor unitDescriptor, ConfigurationHandlers configurationHandlers) throws SAXException
    Returns a JavaOutletSaxHandler for reading the configuration of Java outlets. This implementation uses the provided name as outlet name.
    Angegeben von:
      `getOutletSaxHandler` in Schnittstelle `TypedOutletSaxHandlerFactory`
    Parameter:
      `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.
    Gibt zurück:
      a new JavaOutletSaxHandler.
    Löst aus:
      `SAXException` - if the SAX Handler for the outlet can not be created from the given XML element.