org.codehaus.plexus.components.io.resources.AbstractPlexusIoResourceCollection Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of plexus-io Show documentation
There is a newer version: 3.5.1
package org.codehaus.plexus.components.io.resources;

/*
 * Copyright 2007 The Codehaus Foundation.
 *
 * Licensed under the Apache 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.apache.org/licenses/LICENSE-2.0
 *
 * 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.
 */

import javax.annotation.Nonnull;

import java.io.IOException;
import java.io.InputStream;
import java.util.Iterator;

import org.codehaus.plexus.components.io.filemappers.FileMapper;
import org.codehaus.plexus.components.io.filemappers.PrefixFileMapper;
import org.codehaus.plexus.components.io.fileselectors.FileSelector;
import org.codehaus.plexus.components.io.functions.InputStreamTransformer;

/**
 * Default implementation of a resource collection.
 */
public abstract class AbstractPlexusIoResourceCollection implements PlexusIoResourceCollection {

    static class IdentityTransformer implements InputStreamTransformer {
        @Nonnull
        public InputStream transform(@Nonnull PlexusIoResource resource, @Nonnull InputStream inputStream)
                throws IOException {
            return inputStream;
        }
    }

    public static final InputStreamTransformer identityTransformer = new IdentityTransformer();

    private String prefix;

    private String[] includes;

    private String[] excludes;

    private FileSelector[] fileSelectors;

    private boolean caseSensitive = true;

    private boolean usingDefaultExcludes = true;

    private boolean includingEmptyDirectories = true;

    private FileMapper[] fileMappers;

    private InputStreamTransformer streamTransformer = identityTransformer;

    protected AbstractPlexusIoResourceCollection() {}

    /**
     * Sets a string of patterns, which excluded files
     * should match.
     */
    public void setExcludes(String[] excludes) {
        this.excludes = excludes;
    }

    /**
     * Returns a string of patterns, which excluded files
     * should match.
     */
    public String[] getExcludes() {
        return excludes;
    }

    /**
     * Sets a set of file selectors, which should be used
     * to select the included files.
     */
    public void setFileSelectors(FileSelector[] fileSelectors) {
        this.fileSelectors = fileSelectors;
    }

    /**
     * Returns a set of file selectors, which should be used
     * to select the included files.
     */
    public FileSelector[] getFileSelectors() {
        return fileSelectors;
    }

    public void setStreamTransformer(InputStreamTransformer streamTransformer) {
        if (streamTransformer == null) {
            this.streamTransformer = identityTransformer;
        } else {
            this.streamTransformer = streamTransformer;
        }
    }

    protected InputStreamTransformer getStreamTransformer() {
        return streamTransformer;
    }

    /**
     * Sets a string of patterns, which included files
     * should match.
     */
    public void setIncludes(String[] includes) {
        this.includes = includes;
    }

    /**
     * Returns a string of patterns, which included files
     * should match.
     */
    public String[] getIncludes() {
        return includes;
    }

    /**
     * Sets the prefix, which the file sets contents shall
     * have.
     */
    public void setPrefix(String prefix) {
        this.prefix = prefix;
    }

    /**
     * Returns the prefix, which the file sets contents shall
     * have.
     */
    public String getPrefix() {
        return prefix;
    }

    /**
     * Sets, whether the include/exclude patterns are
     * case sensitive. Defaults to true.
     */
    public void setCaseSensitive(boolean caseSensitive) {
        this.caseSensitive = caseSensitive;
    }

    /**
     * Returns, whether the include/exclude patterns are
     * case sensitive. Defaults to true.
     */
    public boolean isCaseSensitive() {
        return caseSensitive;
    }

    /**
     * Sets, whether the default excludes are being
     * applied. Defaults to true.
     */
    public void setUsingDefaultExcludes(boolean usingDefaultExcludes) {
        this.usingDefaultExcludes = usingDefaultExcludes;
    }

    /**
     * Returns, whether the default excludes are being
     * applied. Defaults to true.
     */
    public boolean isUsingDefaultExcludes() {
        return usingDefaultExcludes;
    }

    /**
     * Sets, whether empty directories are being included. Defaults
     * to true.
     */
    public void setIncludingEmptyDirectories(boolean includingEmptyDirectories) {
        this.includingEmptyDirectories = includingEmptyDirectories;
    }

    /**
     * Returns, whether empty directories are being included. Defaults
     * to true.
     */
    public boolean isIncludingEmptyDirectories() {
        return includingEmptyDirectories;
    }

    protected boolean isSelected(PlexusIoResource plexusIoResource) throws IOException {
        FileSelector[] fileSelectors = getFileSelectors();
        if (fileSelectors != null) {
            for (FileSelector fileSelector : fileSelectors) {
                if (!fileSelector.isSelected(plexusIoResource)) {
                    return false;
                }
            }
        }
        return true;
    }

    /**
     * Returns the file name mappers, which are used to transform
     * the resource names.
     */
    public FileMapper[] getFileMappers() {
        return fileMappers;
    }

    /**
     * Sets the file name mappers, which are used to transform
     * the resource names.
     */
    public void setFileMappers(FileMapper[] fileMappers) {
        this.fileMappers = fileMappers;
    }

    public Iterator iterator() {
        try {
            return getResources();
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }

    public String getName(PlexusIoResource resource) {
        return getName(resource.getName());
    }

    protected String getName(String resourceName) {
        String name = resourceName;
        final FileMapper[] mappers = getFileMappers();
        if (mappers != null) {
            for (FileMapper mapper : mappers) {
                name = mapper.getMappedFileName(name);
            }
        }
        return PrefixFileMapper.getMappedFileName(getPrefix(), name);
    }

    public InputStream getInputStream(PlexusIoResource resource) throws IOException {
        InputStream contents = resource.getContents();
        return new ClosingInputStream(streamTransformer.transform(resource, contents), contents);
    }

    public PlexusIoResource resolve(final PlexusIoResource resource) throws IOException {
        final Deferred deferred = new Deferred(resource, this, streamTransformer != identityTransformer);
        return deferred.asResource();
    }

    public long getLastModified() throws IOException {
        long lastModified = PlexusIoResource.UNKNOWN_MODIFICATION_DATE;
        for (Iterator iter = getResources(); iter.hasNext(); ) {
            long l = iter.next().getLastModified();
            if (l == PlexusIoResource.UNKNOWN_MODIFICATION_DATE) {
                return PlexusIoResource.UNKNOWN_MODIFICATION_DATE;
            }
            if (lastModified == PlexusIoResource.UNKNOWN_MODIFICATION_DATE || l > lastModified) {
                lastModified = l;
            }
        }
        return lastModified;
    }
}