public abstract class Maven2ProjectPaths extends Object implements ProjectPaths
Modifier and Type | Field and Description |
---|---|
protected static String |
CACHE_DIR
Default cache directory.
|
protected static String |
CONFIG_DIR
Default configuration root directory,
relative to the project root.
|
protected static String |
DEFAULT_OUTPUT_DIR
Default generation target directory,
relative to the project root.
|
static String |
MODIFIABLE_OUTPUT_DIR
Default generation target directory for generated files
which are modifiable by the user, relative to the project root.
|
static String |
MODIFIABLE_OUTPUT_DIR_KEY
Key for the target directory for generated files
which are modifiable by the user, relative to the project root.
|
protected static String |
SOURCE_DIR
Default generation source file directory,
relative to the configuration root directory.
|
protected static String |
WORK_DIR
Default working directory.
|
Modifier | Constructor and Description |
---|---|
protected |
Maven2ProjectPaths(File projectRoot)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
File |
getCacheDirectory()
Returns the default cache subdirectory
where the torque generator can store internal files.
|
abstract String |
getConfigurationPackage()
Returns the package of the Torque generator configuration.
|
abstract File |
getConfigurationPath()
Returns the path to the Torque generator configuration directory.
|
File |
getDefaultSourcePath()
Returns the path to the source files.
|
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.
|
protected File |
getProjectRoot()
returns the root directory of the whole maven 2 project.
|
File |
getWorkDirectory()
Returns the default work subdirectory
where the torque generator can store internal files.
|
protected static final String CONFIG_DIR
protected static final String SOURCE_DIR
public static final String MODIFIABLE_OUTPUT_DIR_KEY
public static final String MODIFIABLE_OUTPUT_DIR
protected static final String DEFAULT_OUTPUT_DIR
protected static final String WORK_DIR
protected static final String CACHE_DIR
protected Maven2ProjectPaths(File projectRoot)
projectRoot
- path to the project root directory, not null.
The path must either be absolute or relative to the current
working directory.NullPointerException
- if projectRoot is null.public abstract File getConfigurationPath()
ProjectPaths
getConfigurationPath
in interface ProjectPaths
public abstract String getConfigurationPackage()
ProjectPaths
getConfigurationPackage
in interface ProjectPaths
public File getDefaultSourcePath()
getDefaultSourcePath
in interface ProjectPaths
public Map<String,File> getOutputDirectoryMap()
getOutputDirectoryMap
in interface ProjectPaths
IllegalStateException
- if the current state of the object
is not valid.public File getOutputDirectory(String outputDirKey)
getOutputDirectory
in interface ProjectPaths
outputDirKey
- the output directory key, or null for the default
output directory.IllegalArgumentException
- if the outputDirKey is unknown.public File getWorkDirectory()
getWorkDirectory
in interface ProjectPaths
public File getCacheDirectory()
getCacheDirectory
in interface ProjectPaths
protected File getProjectRoot()
Copyright © 2000–2020 The Apache Software Foundation. All rights reserved.