org.codehaus.mojo.wagon.ListMojo Maven / Gradle / Ivy

Go to download
/**
 * Copyright 2008-2012 The Kuali Foundation
 *
 * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
 *
 * 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.
 */
package org.codehaus.mojo.wagon;

import java.util.List;

import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.wagon.Wagon;
import org.apache.maven.wagon.WagonException;
import org.codehaus.mojo.wagon.shared.WagonFileSet;

/**
 * List the files under a specified directory for a repository
 *
 * @goal list
 * @requiresProject false
 */
public class ListMojo extends AbstractWagonListMojo {

    /**
     * If true, any files found are logged to the console
     *
     * @parameter expression="${wagon.showFiles}" default-value="true"
     */
    protected boolean showFiles;

    @Override
    protected void execute(Wagon wagon) throws MojoExecutionException, WagonException {
        WagonFileSet wagonFileSet = getWagonFileSet();
        List files = wagonDownload.getFileList(wagon, wagonFileSet, getLog());
        if (showFiles) {
            for (String file : files) {
                getLog().info(file);
            }
        }
    }

    public boolean isShowFiles() {
        return showFiles;
    }

    public void setShowFiles(boolean showFiles) {
        this.showFiles = showFiles;
    }
}