# Uses of Interface
org.apache.torque.generator.outlet.Outlet

Packages that use Outlet
Package
Description
org.apache.torque.generator.configuration.controller
This package contains the classes for reading the control configuration of the Torque generator units of generation.
org.apache.torque.generator.configuration.outlet
This package contains the classes for reading the outlet mappings for torque-generator's units of generation.
org.apache.torque.generator.control
This package implements the torque generator Controller .
org.apache.torque.generator.outlet
This package defines torque generator outlets which produce output snippets from the source.
org.apache.torque.generator.outlet.copy
This package defines and implements copy outlets.
org.apache.torque.generator.outlet.java
This package defines java outlets and provides some implementations.
org.apache.torque.generator.template
This package contains the handling of template-based outlets in the Torque generator.
org.apache.torque.generator.template.groovy
This package contains the handling of groovy outlets in the Torque generator.
org.apache.torque.generator.template.velocity
This package contains the handling of velocity outlets in the Torque generator.

- ## Uses of Outlet in org.apache.torque.generator.configuration.controller

  Methods in org.apache.torque.generator.configuration.controller that return Outlet
  Modifier and Type
  Method
  Description
  `Outlet`
  Output.`getFilenameOutlet()`
  Returns the reference to the outlet which should produce the file name.
  Methods in org.apache.torque.generator.configuration.controller with parameters of type Outlet
  Modifier and Type
  Method
  Description
  `void`
  Output.`setFilenameOutlet(Outlet filenameOutlet)`
  Sets the reference to the outlet which should produce the file name.

- ## Uses of Outlet in org.apache.torque.generator.configuration.outlet

  Methods in org.apache.torque.generator.configuration.outlet that return Outlet
  Modifier and Type
  Method
  Description
  `protected abstract Outlet`
  OutletSaxHandler.`createOutlet(QualifiedName outletName, String uri, String localName, String rawName, Attributes attributes)`
  `Outlet`
  CopyOutletSaxHandlerFactory.`createOutletForTemplate(String templatePath, ConfigurationProvider configurationProvider)`
  Creates an outlet for a template with the given file name.
  `Outlet`
  GroovyOutletSaxHandlerFactory.`createOutletForTemplate(String templatePath, ConfigurationProvider configurationProvider)`
  Creates an outlet for a template with the given file name.
  `Outlet`
  JavaOutletSaxHandlerFactory.`createOutletForTemplate(String templatePath, ConfigurationProvider configurationProvider)`
  Creates an outlet for a template with the given file name.
  `Outlet`
  TypedOutletSaxHandlerFactory.`createOutletForTemplate(String templatePath, ConfigurationProvider configurationProvider)`
  Creates an outlet for a template with the given file name.
  `Outlet`
  VelocityOutletSaxHandlerFactory.`createOutletForTemplate(String templatePath, ConfigurationProvider configurationProvider)`
  Creates an outlet for a template with the given file name.
  `Outlet`
  OutletConfiguration.`getOutlet(QualifiedName name)`
  Returns the outlet with the name `name`.
  `Outlet`
  OutletSaxHandler.`getOutlet()`
  Returns the outlet being configured.
  Methods in org.apache.torque.generator.configuration.outlet that return types with arguments of type Outlet
  Modifier and Type
  Method
  Description
  `Map<QualifiedName,Outlet>`
  OutletConfiguration.`getOutlets()`
  Returns a map containing all the configured outlets, keyed by their name.
  `List<Outlet>`
  OutletConfigurationSaxHandler.`getOutlets()`
  Returns all outlets which were configured in the parsed outlet configuration file.
  Methods in org.apache.torque.generator.configuration.outlet with parameters of type Outlet
  Modifier and Type
  Method
  Description
  `void`
  OutletConfiguration.`addOutlet(Outlet outlet, UnitDescriptor unitDescriptor)`
  Adds a outlet.
  Constructor parameters in org.apache.torque.generator.configuration.outlet with type arguments of type Outlet
  Modifier
  Constructor
  Description
  ``
  `OutletConfiguration(Collection<Outlet> outlets, Collection<MergepointMapping> mergepointMappings, UnitDescriptor unitDescriptor)`
  Creates a OutletConfiguration containing a list of Outlets.

- ## Uses of Outlet in org.apache.torque.generator.control

  Methods in org.apache.torque.generator.control that return Outlet
  Modifier and Type
  Method
  Description
  `Outlet`
  ControllerState.`getOutlet()`
  Returns the topmost outlet in the stack of outlets.
  `Outlet`
  ControllerState.`popOutlet()`
  Pops the topmost outlets from the stack of outlets.
  Methods in org.apache.torque.generator.control with parameters of type Outlet
  Modifier and Type
  Method
  Description
  `void`
  ControllerState.`pushOutlet(Outlet outlet)`
  Pushes a outlet onto the stack of outlets.

- ## Uses of Outlet in org.apache.torque.generator.outlet

  Classes in org.apache.torque.generator.outlet that implement Outlet
  Modifier and Type
  Class
  Description
  `class`
  `DebuggingOutletWrapper`
  An outlet wrapper which adds debug information to the outlet.
  `class`
  `OutletImpl`
  Implementation of the features in the `Outlet` interface which do not depend on type of Outlet.
  Constructors in org.apache.torque.generator.outlet with parameters of type Outlet
  Modifier
  Constructor
  Description
  ``
  `DebuggingOutletWrapper(Outlet delegate)`
  Constructor.

- ## Uses of Outlet in org.apache.torque.generator.outlet.copy

  Classes in org.apache.torque.generator.outlet.copy that implement Outlet
  Modifier and Type
  Class
  Description
  `class`
  `CopyOutlet`
  A Outlet which copies a given resource unchanged.

- ## Uses of Outlet in org.apache.torque.generator.outlet.java

  Classes in org.apache.torque.generator.outlet.java that implement Outlet
  Modifier and Type
  Class
  Description
  `class`
  `CamelbackOutlet`
  Transform a String to its camelback version.
  `class`
  `ConstantNameOutlet`
  Creates the name of a constant from a string.
  `class`
  `JavadocOutlet`
  An outlet for creating correctly formatted javadoc.
  `class`
  `JavaFilenameOutlet`
  Takes a class name and a package name as input and generates a filename(including path for package) for a java file from it.
  `class`
  `ModifySourcenameOutlet`
  Creates a target filename from a source filename.
  `class`
  `NewlineOutlet`
  Creates new lines (\n or \r\n).
  `class`
  `OptionOutlet`
  Writes an option to the output.
  `class`
  `OutletWithoutMergepoints`
  An outlet without mergepoints.
  `class`
  `PackageToPathOutlet`
  Takes a package as input and generates a path from it.
  `class`
  `StringInputOutlet`
  A base class for a outlet which takes a String as input (not a Source Element as a normal outlet would).
  `class`
  `XmlOutlet`
  Outputs the source tree as XML.

- ## Uses of Outlet in org.apache.torque.generator.template

  Subinterfaces of Outlet in org.apache.torque.generator.template
  Modifier and Type
  Interface
  Description
  `interface`
  `TemplateOutlet`
  A Outlet which interprets a template.
  Classes in org.apache.torque.generator.template that implement Outlet
  Modifier and Type
  Class
  Description
  `class`
  `TemplateOutletImpl`
  An implementation of the TemplateOutlet interface.

- ## Uses of Outlet in org.apache.torque.generator.template.groovy

  Classes in org.apache.torque.generator.template.groovy that implement Outlet
  Modifier and Type
  Class
  Description
  `class`
  `GroovyOutlet`
  A Outlet which uses groovy for generation.
  `class`
  `GroovyScriptOutlet`
  A Outlet which uses a groovy script for generation.
  `class`
  `GroovyTemplateOutlet`
  A Outlet which uses a groovy template for generation.

- ## Uses of Outlet in org.apache.torque.generator.template.velocity

  Classes in org.apache.torque.generator.template.velocity that implement Outlet
  Modifier and Type
  Class
  Description
  `class`
  `VelocityOutlet`
  A Outlet which uses a velocity template for generation.