Package org.apache.torque.generator.control.existingtargetstrategy

# Schnittstelle ExistingTargetStrategy

Alle bekannten Implementierungsklassen:
  `AppendToTargetFileStrategy`, `MergeTargetFileStrategy`, `ReplaceTargetFileStrategy`, `SkipExistingTargetFileStrategy`

public interface ExistingTargetStrategy
A handler which implements a strategy on how to deal with existing targets.

Version:
  $Id: ExistingTargetStrategy.java 1917241 2024-04-21 13:29:41Z tv $

- ## Methodenübersicht

  Modifizierer und Typ
  Methode
  Beschreibung
  `void`
  `afterGeneration(String outputDirKey, String outputPath, Charset charSet, OutletResult generationResult, UnitConfiguration unitConfiguration)`
  Processes the results of the generation.
  `boolean`
  `beforeGeneration(String outputDirKey, String outputPath, Charset charSet, UnitConfiguration unitConfiguration)`
  Will be called before the generation is started and decides whether the generation process for this file should proceed.
  `String`
  `getStrategyName()`
  Returns the name of the existing target strategy.

- ## Methodendetails

  - ### beforeGeneration

    boolean beforeGeneration(String outputDirKey, String outputPath, Charset charSet, UnitConfiguration unitConfiguration) throws GeneratorException
    Will be called before the generation is started and decides whether the generation process for this file should proceed.
    Parameter:
      `outputDirKey` - the key for the output directory into which the generated file should be written, null for the default output directory.
      `outputPath` - the path to which the output should be written, relative to the output base directory.
      `charSet` - The character encoding of the generated file, or null for the platform default encoding.
      `unitConfiguration` - the configuration of the current configuration unit, not null.
    Gibt zurück:
      true if generation should proceed, false if generation should be aborted.
    Löst aus:
      `GeneratorException` - on an error.

  - ### afterGeneration

    void afterGeneration(String outputDirKey, String outputPath, Charset charSet, OutletResult generationResult, UnitConfiguration unitConfiguration) throws GeneratorException
    Processes the results of the generation.
    Parameter:
      `outputDirKey` - the key for the output directory into which the generated file should be written, null for the default output directory.
      `outputPath` - the path to which the output should be written, relative to the output base directory.
      `charSet` - The character encoding of the generated file, or null for the platform default encoding.
      `generationResult` - the result of the generation, not null.
      `unitConfiguration` - the configuration of the current configuration unit, not null.
    Löst aus:
      `GeneratorException` - on an error.

  - ### getStrategyName

    String getStrategyName()
    Returns the name of the existing target strategy.
    Gibt zurück:
      the strategy name, not null, must be different from the names of other strategies.