Klasse Maven2ProjectPaths

java.lang.Object
org.apache.torque.generator.configuration.paths.Maven2ProjectPaths
Alle implementierten Schnittstellen:
ProjectPaths
Bekannte direkte Unterklassen:
Maven2DirectoryProjectPaths, Maven2JarProjectPaths

public abstract class Maven2ProjectPaths extends Object implements ProjectPaths
Contains information of the default integration of the Torque generator into a maven 2 project.
  • Felddetails

    • CONFIG_DIR

      protected static final String CONFIG_DIR
      Default configuration root directory, relative to the project root.
      Siehe auch:
    • SOURCE_DIR

      protected static final String SOURCE_DIR
      Default generation source file directory, relative to the configuration root directory.
      Siehe auch:
    • MODIFIABLE_OUTPUT_DIR_KEY

      public static final String 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

      public static final String 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

      protected static final String DEFAULT_OUTPUT_DIR
      Default generation target directory, relative to the project root.
      Siehe auch:
    • WORK_DIR

      protected static final String WORK_DIR
      Default working directory.
      Siehe auch:
    • CACHE_DIR

      protected static final String CACHE_DIR
      Default cache directory.
      Siehe auch:
  • Konstruktordetails

    • Maven2ProjectPaths

      protected Maven2ProjectPaths(File projectRoot)
      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

      public abstract File 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 Schnittstelle ProjectPaths
      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

      public abstract String getConfigurationPackage()
      Beschreibung aus Schnittstelle kopiert: ProjectPaths
      Returns the package of the Torque generator configuration.
      Angegeben von:
      getConfigurationPackage in Schnittstelle ProjectPaths
      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

      public File getDefaultSourcePath()
      Returns the path to the source files.
      Angegeben von:
      getDefaultSourcePath in Schnittstelle ProjectPaths
      Gibt zurück:
      the path to for the source files, not null.
    • getOutputDirectoryMap

      public Map<String,File> getOutputDirectoryMap()
      Returns the output directory map which contains the mapping from output directory key to output directory.
      Angegeben von:
      getOutputDirectoryMap in Schnittstelle ProjectPaths
      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

      public File getOutputDirectory(String outputDirKey)
      Returns the output directory for a given output directory key.
      Angegeben von:
      getOutputDirectory in Schnittstelle ProjectPaths
      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

      public File getWorkDirectory()
      Returns the default work subdirectory where the torque generator can store internal files.
      Angegeben von:
      getWorkDirectory in Schnittstelle ProjectPaths
      Gibt zurück:
      the work subdirectory, not null.
    • getCacheDirectory

      public File getCacheDirectory()
      Returns the default cache subdirectory where the torque generator can store internal files.
      Angegeben von:
      getCacheDirectory in Schnittstelle ProjectPaths
      Gibt zurück:
      the work subdirectory, not null.
    • getProjectRoot

      protected File getProjectRoot()
      returns the root directory of the whole maven 2 project.
      Gibt zurück:
      the root directory of the whole project, not null.