/*

 * Copyright (c) 2007-2008 Nokia Corporation and/or its subsidiary(-ies).

 * All rights reserved.

 * This component and the accompanying materials are made available

 * under the terms of the License "Eclipse Public License v1.0"

 * which accompanies this distribution, and is available

 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

 *

 * Initial Contributors:

 * Nokia Corporation - initial contribution.

 *

 * Contributors:

 *

 * Description:  

 *

 */

package com.nokia.helium.logger.ant.types;

import java.io.File;

import org.apache.tools.ant.Project;

import org.apache.tools.ant.types.DataType;

import com.nokia.helium.logger.ant.listener.StageSummaryHandler;

import com.nokia.helium.logger.ant.listener.StatusAndLogListener;

/**

 * <code>StageSummary</code> is a Data type when set a build summary is 

 * displayed at the end of build process.

 * 

 * <pre>

 * Usage:

 *       <hlm:stagesummary id="stage.summary" 

 *          template="${template.dir}\build_stages_summary.txt.ftl"/>

 * </pre>

 * 

 * @ant.task name="stagesummary" category="Logging"

 * 

 */

public class StageSummary extends DataType {

    private static boolean isStageSummaryHandlerRegistered;

    private File template;

    private Logger log = Logger.getLogger(getClass());

    public void setProject(Project project)

    {

        super.setProject(project);

        if ( !isStageSummaryHandlerRegistered && StatusAndLogListener.getStatusAndLogListener() != null) {

            log.debug("Registering stage summary to the StatusAndLogListener listener");

            StatusAndLogListener.getStatusAndLogListener().register( new StageSummaryHandler() );

            isStageSummaryHandlerRegistered = true;

        }

    }

    /**

     * Get the template used for displaying build stage summary.

     * 

     * @return the template to display build stage summary.

     */

    public File getTemplate() {

        return template;

    }

    /**

     * Set the template to be used for displaying build stage summary.

     * 

     * @param template

     *            the template to set

     * @ant.required           

     */

    public void setTemplate( File template ) {

        this.template = template;

    }

}