org.apache.torque.generator.control.existingtargetstrategy.ReplaceTargetFileStrategy.java Source code

Introduction

Here is the source code for org.apache.torque.generator.control.existingtargetstrategy.ReplaceTargetFileStrategy.java

Source

package org.apache.torque.generator.control.existingtargetstrategy;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import java.io.File;
import java.io.IOException;

import org.apache.commons.io.FileUtils;
import org.apache.torque.generator.GeneratorException;
import org.apache.torque.generator.configuration.UnitConfiguration;
import org.apache.torque.generator.control.ControllerException;
import org.apache.torque.generator.control.ControllerHelper;
import org.apache.torque.generator.outlet.OutletResult;

/**
 * A handler which implements the strategy to replace existing target files.
 *
 * @version $Id: ReplaceTargetFileStrategy.java 1368426 2012-08-02 11:46:37Z tfischer $
 */
public class ReplaceTargetFileStrategy implements ExistingTargetStrategy {
    /** The strategy name "replace". */
    public static final String STRATEGY_NAME = "replace";

    /**
     * Will be called before the generation is started and decides whether
     * the generation process for this file should proceed.
     *
     * @param outputDirKey the key for the output directory
     *        into which the generated file should be written,
     *        null for the default output directory.
     * @param outputPath the path to which the output should be written,
     *        relative to the output base directory.
     * @param encoding The character encoding of the generated file,
     *        or null for the platform default encoding.
     * @param unitConfiguration the configuration of the current configuration
     *        unit, not null.
     *
     * @return true always.
     */
    public boolean beforeGeneration(String outputDirKey, String outputPath, String encoding,
            UnitConfiguration unitConfiguration) {
        return true;
    }

    /**
     * Processes the results of the generation.
     *
     * @param outputDirKey the key for the output directory
     *        into which the generated file should be written,
     *        null for the default output directory.
     * @param outputPath the path to which the output should be written,
     *        relative to the output base directory.
     * @param encoding The character encoding of the generated file,
     *        or null for the platform default encoding.
     * @param generationResult the result of the generation, not null.
     * @param unitConfiguration the configuration of the current configuration
     *        unit, not null.
     * @throws GeneratorException on an error.
     */
    public void afterGeneration(String outputDirKey, String outputPath, String encoding,
            OutletResult generationResult, UnitConfiguration unitConfiguration) throws GeneratorException {
        File outputFile = ControllerHelper.getOutputFile(outputDirKey, outputPath, unitConfiguration);
        try {
            if (generationResult.isStringResult()) {
                FileUtils.writeStringToFile(outputFile, generationResult.getStringResult(), encoding);
            } else {
                FileUtils.writeByteArrayToFile(outputFile, generationResult.getByteArrayResult());
            }
        } catch (IOException e) {
            throw new ControllerException("Could not write file \"" + outputFile.getAbsolutePath() + "\"", e);
        }
    }

    /**
     * Returns the name of the existing target strategy.
     *
     * @return "replace"
     */
    public String getStrategyName() {
        return STRATEGY_NAME;
    }
}