Klasse Maven2ProjectPaths
java.lang.Object
org.apache.torque.generator.configuration.paths.Maven2ProjectPaths
- Alle implementierten Schnittstellen:
ProjectPaths
- Bekannte direkte Unterklassen:
Maven2DirectoryProjectPaths
,Maven2JarProjectPaths
Contains information of the default integration of the Torque generator
into a maven 2 project.
-
Feldübersicht
FelderModifizierer und TypFeldBeschreibungprotected static final String
Default cache directory.protected static final String
Default configuration root directory, relative to the project root.protected static final String
Default generation target directory, relative to the project root.static final String
Default generation target directory for generated files which are modifiable by the user, relative to the project root.static final String
Key for the target directory for generated files which are modifiable by the user, relative to the project root.protected static final String
Default generation source file directory, relative to the configuration root directory.protected static final String
Default working directory. -
Konstruktorübersicht
Konstruktoren -
Methodenübersicht
Modifizierer und TypMethodeBeschreibungReturns the default cache subdirectory where the torque generator can store internal files.abstract String
Returns the package of the Torque generator configuration.abstract File
Returns the path to the Torque generator configuration directory.Returns the path to the source files.getOutputDirectory
(String outputDirKey) Returns the output directory for a given output directory key.Returns the output directory map which contains the mapping from output directory key to output directory.protected File
returns the root directory of the whole maven 2 project.Returns the default work subdirectory where the torque generator can store internal files.
-
Felddetails
-
CONFIG_DIR
Default configuration root directory, relative to the project root.- Siehe auch:
-
SOURCE_DIR
Default generation source file directory, relative to the configuration root directory.- Siehe auch:
-
MODIFIABLE_OUTPUT_DIR_KEY
Key for the target directory for generated files which are modifiable by the user, relative to the project root.- Siehe auch:
-
MODIFIABLE_OUTPUT_DIR
Default generation target directory for generated files which are modifiable by the user, relative to the project root.- Siehe auch:
-
DEFAULT_OUTPUT_DIR
Default generation target directory, relative to the project root.- Siehe auch:
-
WORK_DIR
Default working directory.- Siehe auch:
-
CACHE_DIR
Default cache directory.- Siehe auch:
-
-
Konstruktordetails
-
Maven2ProjectPaths
Constructor.- Parameter:
projectRoot
- path to the project root directory, not null. The path must either be absolute or relative to the current working directory.- Löst aus:
NullPointerException
- if projectRoot is null.
-
-
Methodendetails
-
getConfigurationPath
Beschreibung aus Schnittstelle kopiert:ProjectPaths
Returns the path to the Torque generator configuration directory. The path must either be absolute or relative to the current working directory.- Angegeben von:
getConfigurationPath
in SchnittstelleProjectPaths
- Gibt zurück:
- the path to the Torque generator configuration; may (but must not) be null if no configuration is contained in the surrounding project; must be null if the configuration is read from the class path.
-
getConfigurationPackage
Beschreibung aus Schnittstelle kopiert:ProjectPaths
Returns the package of the Torque generator configuration.- Angegeben von:
getConfigurationPackage
in SchnittstelleProjectPaths
- Gibt zurück:
- the package to the Torque generator configuration. Must be null if the configuration is read from the file system or from a jar file. Must not be null if the configuration is read from the class path.
-
getDefaultSourcePath
Returns the path to the source files.- Angegeben von:
getDefaultSourcePath
in SchnittstelleProjectPaths
- Gibt zurück:
- the path to for the source files, not null.
-
getOutputDirectoryMap
Returns the output directory map which contains the mapping from output directory key to output directory.- Angegeben von:
getOutputDirectoryMap
in SchnittstelleProjectPaths
- Gibt zurück:
- the unmodifiable output directory map, not null. Contains a mapping for the keys null and "modifiable".
- Löst aus:
IllegalStateException
- if the current state of the object is not valid.
-
getOutputDirectory
Returns the output directory for a given output directory key.- Angegeben von:
getOutputDirectory
in SchnittstelleProjectPaths
- Parameter:
outputDirKey
- the output directory key, or null for the default output directory.- Gibt zurück:
- the output directory for the key, relative to the current directory, or absolute, not null.
- Löst aus:
IllegalArgumentException
- if the outputDirKey is unknown.
-
getWorkDirectory
Returns the default work subdirectory where the torque generator can store internal files.- Angegeben von:
getWorkDirectory
in SchnittstelleProjectPaths
- Gibt zurück:
- the work subdirectory, not null.
-
getCacheDirectory
Returns the default cache subdirectory where the torque generator can store internal files.- Angegeben von:
getCacheDirectory
in SchnittstelleProjectPaths
- Gibt zurück:
- the work subdirectory, not null.
-
getProjectRoot
returns the root directory of the whole maven 2 project.- Gibt zurück:
- the root directory of the whole project, not null.
-