package org.apache.maven.checkstyle;

/* ====================================================================
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2002 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Apache" and "Apache Software Foundation" and
 *    "Apache Maven" must not be used to endorse or promote products
 *    derived from this software without prior written permission. For
 *    written permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache",
 *    "Apache Maven", nor may "Apache" appear in their name, without
 *    prior written permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */

import java.io.File;

import com.puppycrawl.tools.checkstyle.CheckStyleTask;
import org.apache.tools.ant.types.Path;
import org.apache.tools.ant.types.FileSet;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.Project;

/**
 * Extends the Checkstyle task by automatically adding all the source
 * entries from the Maven POM (i.e. the entries found in
 * &lt;sourceDirectory&gt; tags in <code>project.xml</code>) as filesets. There
 * is no other way to dynamically define a set of directories that Checkstyle
 * will use.
 *
 * @author <a href="vmassol@apache.org">Vincent Massol</a>
 * @version $Id: ProjectProperties.java,v 1.33 2002/05/23 01:17:01 dion Exp $
 */
public class MavenCheckStyleTask extends CheckStyleTask
{
    /**
     * Path to be transformed into filesets.
     */
    private Path path;

    /**
     * Create a nested PATH element
     */
    public Path createPath()
    {
        if (this.path == null) {
            this.path = new Path(getProject());
        }
        return this.path.createPath();
    }

    /**
     * Transform path entries into filesets entries using the maven
     * <code>maven.checkstyle.includes</code> and
     * <code>maven.checkstyle.excludes</code> properties, and then call the
     * Checkstyle task <code>execute()</code> method.
     *
     * @throws BuildException
     */
    public void execute() throws BuildException
    {
        String includes = getProject().getProperty("maven.checkstyle.includes");
        String excludes = getProject().getProperty("maven.checkstyle.excludes");

        log("Includes = [" + includes + "]", Project.MSG_DEBUG);
        log("Excludes = [" + excludes + "]", Project.MSG_DEBUG);

        String[] paths = this.path.list();
        for (int i = 0; i < paths.length; i++)
        {
            log("Adding path [" + paths[i] + "] to fileset list",
                Project.MSG_DEBUG);

            FileSet fileset = new FileSet();

            if (includes != null)
            {
                fileset.setIncludes(includes);
            }
            if (excludes != null)
            {
                fileset.setExcludes(excludes);
            }

            fileset.setDir(new File(paths[i]));
            addFileset(fileset);
        }

        // Execute the Checkstyle task
        super.execute();
    }
}