org.apache.torque.generator.configuration
Class ClasspathConfigurationProvider

java.lang.Object
  extended by org.apache.torque.generator.configuration.AbstractConfigurationProvider
      extended by org.apache.torque.generator.configuration.ClasspathConfigurationProvider
All Implemented Interfaces:
ConfigurationProvider

public class ClasspathConfigurationProvider
extends AbstractConfigurationProvider

Provides InputStreams to read a configuration of a unit of generation from a jar file.


Constructor Summary
ClasspathConfigurationProvider(ProjectPaths projectPaths, TorqueGeneratorPaths configurationPaths)
          Constructor.
 
Method Summary
 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.
 
Methods inherited from class org.apache.torque.generator.configuration.AbstractConfigurationProvider
getControlConfigurationInputStream, getOptionsInputStream, getOutletConfigurationInputStream, getResourceInputStream, getTemplateInputStream
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ClasspathConfigurationProvider

public ClasspathConfigurationProvider(ProjectPaths projectPaths,
                                      TorqueGeneratorPaths configurationPaths)
Constructor.

Parameters:
projectPaths - the paths needed to interact with the enclosing project, not null.
configurationPaths - The internal directory structure of the Torque generator configuration files, not null.
Throws:
NullPointerException - if projectPaths or configurationPaths are null.
Method Detail

getControlConfigurationLocation

public String getControlConfigurationLocation()
Description copied from interface: ConfigurationProvider
Returns the location of the control configuration as human readable String for debugging and error tracking purposes.

Returns:
the location of the control configuration, not null.

getFileName

protected String getFileName(String name,
                             String directory)

getInputStream

protected InputStream getInputStream(String name,
                                     String directory,
                                     String fileDescription)
                              throws ConfigurationException
Specified by:
getInputStream in class AbstractConfigurationProvider
Throws:
ConfigurationException

getOutletConfigurationNames

public Collection<String> getOutletConfigurationNames()
                                               throws ConfigurationException
Description copied from interface: ConfigurationProvider
Returns a list of all found outlet configuration files in the generation unit.

Returns:
a list with the generation configuration files, not null.
Throws:
ConfigurationException - if the configuration can not be read.


Copyright © 2000-2013 The Apache Software Foundation. All Rights Reserved.