|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.torque.generator.configuration.paths.CustomProjectPaths
public class CustomProjectPaths
Implementation of ProjectPaths with custom paths.
| Constructor Summary | |
|---|---|
CustomProjectPaths(File configurationDir,
String configurationPackage,
File sourceDir,
Map<String,File> outputDirectoryMap,
File workDir)
Constructor. |
|
CustomProjectPaths(ProjectPaths toCopy)
Copy-constructor. |
|
| Method Summary | |
|---|---|
void |
checkInit()
Checks whether the current settings are valid. |
String |
getConfigurationPackage()
Returns the root package of the Torque generator files. |
File |
getConfigurationPath()
Returns the root directory for the Torque generator files, relative to the project root. |
File |
getDefaultSourcePath()
Returns the default directory for the source files, relative to the project root. |
File |
getOutputDirectory(String outputDirKey)
Returns the output directory for a given output directory key. |
Map<String,File> |
getOutputDirectoryMap()
Returns the output directory map which contains the mapping from output directory key to output directory. |
File |
getWorkDirectory()
Returns the directory where the torque generator can store internal files, relative to the project root. |
void |
setConfigurationDir(File configurationDir)
Sets the root directory for the Torque generator configuration files, absolute or relative to the project root. |
void |
setConfigurationPackage(String configurationPackage)
Sets the root package for the Torque generator files, relative to the project root. |
void |
setOutputDirectory(String outputDirKey,
File outputDir)
Sets the output directory for a given output directory key. |
void |
setOutputDirectoryMap(Map<String,File> outputDirectoryMap)
Sets the contents of the output directory map. |
void |
setSourceDir(File sourceDir)
Sets the default directory for the source files, relative to the current directory, or absolute. |
void |
setWorkDir(File workDir)
Sets the directory where the torque generator can store internal files, relative to the current directory, or absolute. |
String |
toString()
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public CustomProjectPaths(ProjectPaths toCopy)
toCopy - the default project paths to copy, not null.
NullPointerException - if toCopy is null.
public CustomProjectPaths(File configurationDir,
String configurationPackage,
File sourceDir,
Map<String,File> outputDirectoryMap,
File workDir)
configurationDir - the configuration directory for the Torque
generator configuration files, or null if the configuration files
are loaded from the classpath.configurationPackage - the package containing the Torque
generator configuration files, or null if the configuration files
are loaded from the file system.sourceDir - the default directory for the source files, or null.outputDirectoryMap - The output directories for the files,
keyed by the output directory key. The directory with the key
null is the default output directory.workDir - directory where the torque generator can store
internal files.| Method Detail |
|---|
public void setConfigurationDir(File configurationDir)
configurationDir - the configuration directory for the Torque
generator configuration files, null to invalidate the current
setting.public void setConfigurationPackage(String configurationPackage)
configurationPackage - the configuration root package
for the Torque generator files.public void setSourceDir(File sourceDir)
sourceDir - the default directory for the source files,
null to invalidate the current setting.
public void setOutputDirectory(String outputDirKey,
File outputDir)
outputDirKey - the output directory key, or null for the default
output directory.outputDir - the output directory for the key,
relative to the current directory, or absolute.
Use null to remove the output directory for the key.public void setOutputDirectoryMap(Map<String,File> outputDirectoryMap)
outputDirectoryMap - the new output directory map.public void setWorkDir(File workDir)
workDir - the directory for internal files,
null to invalidate the current setting.public File getConfigurationPath()
getConfigurationPath in interface ProjectPathsIllegalStateException - if one of the required parameters
is not set.public String getConfigurationPackage()
getConfigurationPackage in interface ProjectPathsIllegalStateException - if one of the required parameters
is not set.public File getDefaultSourcePath()
getDefaultSourcePath in interface ProjectPathsIllegalStateException - if one of the required parameters
is not set.public File getOutputDirectory(String outputDirKey)
getOutputDirectory in interface ProjectPathsoutputDirKey - the output directory key, or null for the default
output directory.
IllegalStateException - if one of the required parameters
is not set.
IllegalArgumentException - if the outputDirKey is unknown.public Map<String,File> getOutputDirectoryMap()
getOutputDirectoryMap in interface ProjectPathsIllegalStateException - if one of the required parameters
is not set.public File getWorkDirectory()
getWorkDirectory in interface ProjectPathsIllegalStateException - if one of the required parameters
is not set.public void checkInit()
true - if the current settings are valid, false otherwise.public String toString()
toString in class Object
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||