MockCompilingTask.java

/**
 * Copyright (C) 2008-2010, Squale Project - http://www.squale.org
 *
 * This file is part of Squale.
 *
 * Squale is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or any later version.
 *
 * Squale is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Squale.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.squale.squalix.tools.compiling;

import java.util.List;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import org.squale.squalecommon.enterpriselayer.businessobject.component.parameters.ListParameterBO;
import org.squale.squalecommon.enterpriselayer.businessobject.component.parameters.MapParameterBO;
import org.squale.squalecommon.enterpriselayer.businessobject.component.parameters.ParametersConstants;
import org.squale.squalix.core.AbstractTask;
import org.squale.squalix.core.TaskException;
import org.squale.squalix.core.exception.ConfigurationException;

/**
 * T�che de compilation dans le cas d'un projet d�j� compil� Cette t�che sert juste � mettre � jour les param�tres
 * temporaires li�s � la t�che de compilation
 */
public abstract class MockCompilingTask
    extends AbstractTask
{
    /**
     * Logger
     */
    private static final Log LOGGER = LogFactory.getLog( MockCompilingTask.class );

    /** Les param�tres li�s � la t�che */
    protected MapParameterBO mTaskParam;

    // Cette tache n'a pas d'influence dans le calcul de la taille max du file system

    /**
     * {@inheritDoc}
     * 
     * @see org.squale.squalix.core.AbstractTask#execute()
     */
    public void execute()
        throws TaskException
    {
        try
        {
            // On r�cup�re les param�tres li�s � la t�che
            mTaskParam = (MapParameterBO) mProject.getParameter( ParametersConstants.COMPILED );
            if ( mTaskParam == null )
            {
                String message = CompilingMessages.getString( "exception.project.not_configured" );
                LOGGER.error( message );
                // Renvoi d'une exception de configuration
                throw new ConfigurationException( message );
            }
            // Les param�tres doivent contenir les chemins vers les sources compil�es
            ListParameterBO compiledSourcesParam =
                (ListParameterBO) mTaskParam.getParameters().get( ParametersConstants.COMPILED_SOURCES_DIRS );
            if ( compiledSourcesParam == null )
            {
                String message = CompilingMessages.getString( "exception.compiled_sources_dirs_not_set" );
                LOGGER.error( message );
                // Renvoi d'une exception de configuration
                throw new ConfigurationException( message );
            }
            List compiledSourcesDirs = compiledSourcesParam.getParameters();
            setCompiledDirInTempMap( compiledSourcesDirs );
            // positionne les donn�es sur la taille du file System
            affectFileSystemSize( mProject.getParameter( ParametersConstants.SOURCES ), true );
        }
        catch ( Exception e )
        {
            throw new TaskException( e );
        }
    }

    /**
     * Positionne la variable donnant le chemin du r�pertoire racine contenant les fichiers compil�s du projet.
     * 
     * @param pDirs la liste de StringParameterBO repr�sentant les r�pertoires ou fichiers compress�s contenant les
     *            fichiers compil�s
     * @throws TaskException si erreur
     */
    protected abstract void setCompiledDirInTempMap( List pDirs )
        throws TaskException;

}