org.codehaus.mojo.wagon.shared.WagonFileSet 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.shared;

import java.io.File;

/**
 * Wagon configuration to scan for a set of remote files.
 */
public class WagonFileSet {

    /**
     * Path after the url, this is where the scan starts
     */
    private String directory = "";

    /**
     * Ant's excludes path expression
     */
    private String[] excludes;

    /**
     * Ant's includes path expression
     */
    private String[] includes;

    /**
     *
     */
    private boolean caseSensitive;

    /**
     * User default exclude sets
     */
    private boolean useDefaultExcludes = true;

    /**
     * Local path to download the remote files to
     */
    private File downloadDirectory;

    /**
     * Relative to the remote URL. Used to copy files between 2 URLs.
     */
    private String outputDirectory = "";

    public String getDirectory() {
        return directory;
    }

    public void setDirectory(String remotePath) {
        this.directory = remotePath;
    }

    public File getDownloadDirectory() {
        return downloadDirectory;
    }

    public void setDownloadDirectory(File downloadDirectory) {
        this.downloadDirectory = downloadDirectory;
    }

    public String[] getExcludes() {
        return excludes;
    }

    public void setExcludes(String[] excludes) {
        this.excludes = excludes;
    }

    public String[] getIncludes() {
        return includes;
    }

    public void setIncludes(String[] includes) {
        this.includes = includes;
    }

    public boolean isCaseSensitive() {
        return caseSensitive;
    }

    public void setCaseSensitive(boolean caseSensitive) {
        this.caseSensitive = caseSensitive;
    }

    /**
     * Retrieves the included and excluded files from this file-set's directory. Specifically,
     * "file-set: [directory] (included:
     * [included files], excluded: [excluded files])"
     *
     * @return The included and excluded files from this file-set's directory. Specifically,
     *         "file-set: [directory] (included:
     * [included files], excluded: [excluded files])"
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        return "file-set: " + getDirectory() + " (included: " + getIncludes() + ", excluded: " + getExcludes() + ")";
    }

    public boolean isUseDefaultExcludes() {
        return useDefaultExcludes;
    }

    public void setUseDefaultExcludes(boolean useDefaultExcludes) {
        this.useDefaultExcludes = useDefaultExcludes;
    }

    public String getOutputDirectory() {
        return outputDirectory;
    }

    public void setOutputDirectory(String outputDirectory) {
        this.outputDirectory = outputDirectory;
    }

}