Package org.apache.torque.generator.configuration

# Klasse ClasspathConfigurationProvider

java.lang.Object
org.apache.torque.generator.configuration.AbstractConfigurationProvider
org.apache.torque.generator.configuration.ClasspathConfigurationProvider

Alle implementierten Schnittstellen:
  `ConfigurationProvider`

public class ClasspathConfigurationProvider extends AbstractConfigurationProvider
Provides InputStreams to read a configuration of a unit of generation from a jar file.

- ## Konstruktorübersicht

  Konstruktoren
  Konstruktor
  Beschreibung
  `ClasspathConfigurationProvider(UnitDescriptor unitDescriptor)`
  Constructor.

- ## Methodenübersicht

  Modifizierer und Typ
  Methode
  Beschreibung
  `String`
  `getControlConfigurationLocation()`
  Returns the location of the control configuration as human readable String for debugging and error tracking purposes.
  `protected String`
  `getFileName(String name, String directory)`
  `protected InputStream`
  `getInputStream(String name, String directory, String fileDescription)`
  `Collection<String>`
  `getOutletConfigurationNames()`
  Returns a list of all found outlet configuration files in the generation unit.
  `Collection<String>`
  `getTemplateNames()`
  Lists all available template names.

  ### Von Klasse geerbte Methoden org.apache.torque.generator.configuration.AbstractConfigurationProvider

  `getControlConfigurationInputStream, getOptionsInputStream, getOutletConfigurationInputStream, getResourceInputStream, getTemplateInputStream`

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

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

- ## Konstruktordetails

  - ### ClasspathConfigurationProvider

    public ClasspathConfigurationProvider(UnitDescriptor unitDescriptor)
    Constructor.
    Parameter:
      `unitDescriptor` - The description of the generation unit, not null.
    Löst aus:
      `NullPointerException` - if unitDescriptor is null.

- ## Methodendetails

  - ### getControlConfigurationLocation

    public String getControlConfigurationLocation()
    Beschreibung aus Schnittstelle kopiert: `ConfigurationProvider`
    Returns the location of the control configuration as human readable String for debugging and error tracking purposes.
    Gibt zurück:
      the location of the control configuration, not null.
    Siehe auch:
      - `ConfigurationProvider.getControlConfigurationLocation()`

  - ### getFileName

    protected String getFileName(String name, String directory)

  - ### getInputStream

    protected InputStream getInputStream(String name, String directory, String fileDescription) throws ConfigurationException
    Angegeben von:
      `getInputStream` in Klasse `AbstractConfigurationProvider`
    Parameter:
      `name` - input stream name
      `directory` - location
      `fileDescription` - describes the file
    Gibt zurück:
      an InputStream
    Löst aus:
      `ConfigurationException` - if unable to process

  - ### getOutletConfigurationNames

    public Collection<String> getOutletConfigurationNames() throws ConfigurationException
    Beschreibung aus Schnittstelle kopiert: `ConfigurationProvider`
    Returns a list of all found outlet configuration files in the generation unit.
    Gibt zurück:
      a list with the generation configuration files, not null.
    Löst aus:
      `ConfigurationException` - if the configuration can not be read.

  - ### getTemplateNames

    public Collection<String> getTemplateNames() throws ConfigurationException
    Beschreibung aus Schnittstelle kopiert: `ConfigurationProvider`
    Lists all available template names.
    Gibt zurück:
      a collection of all available template names, not null.
    Löst aus:
      `ConfigurationException` - if the template names cannot be determined.
    Siehe auch:
      - `ConfigurationProvider.getTemplateNames()`