/*
* Copyright 2010 the original author or authors.
*
* 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.
*/
package org.gradle.api.internal.file;
import groovy.lang.Closure;
import org.apache.commons.lang.StringUtils;
import org.gradle.api.file.FileCollection;
import org.gradle.api.file.FileTree;
import org.gradle.api.internal.tasks.DefaultTaskDependency;
import org.gradle.api.specs.Spec;
import org.gradle.api.specs.Specs;
import org.gradle.api.tasks.StopExecutionException;
import org.gradle.api.tasks.TaskDependency;
import org.gradle.util.GUtil;
import java.io.File;
import java.util.*;
public abstract class AbstractFileCollection implements FileCollection {
/**
* Returns the display name of this file collection. Used in log and error messages.
*
* @return the display name
*/
public abstract String getDisplayName();
@Override
public String toString() {
return getDisplayName();
}
public File getSingleFile() throws IllegalStateException {
Collection<File> files = getFiles();
if (files.isEmpty()) {
throw new IllegalStateException(String.format(
"Expected %s to contain exactly one file, however, it contains no files.", getDisplayName()));
}
if (files.size() != 1) {
throw new IllegalStateException(String.format(
"Expected %s to contain exactly one file, however, it contains %d files.", getDisplayName(),
files.size()));
}
return files.iterator().next();
}
public Iterator<File> iterator() {
return getFiles().iterator();
}
public String getAsPath() {
return GUtil.join(getFiles(), File.pathSeparator);
}
public boolean contains(File file) {
return getFiles().contains(file);
}
public FileCollection plus(FileCollection collection) {
return new UnionFileCollection(this, collection);
}
public FileCollection minus(final FileCollection collection) {
return new AbstractFileCollection() {
@Override
public String getDisplayName() {
return AbstractFileCollection.this.getDisplayName();
}
@Override
public TaskDependency getBuildDependencies() {
return AbstractFileCollection.this.getBuildDependencies();
}
public Set<File> getFiles() {
Set<File> files = new LinkedHashSet<File>(AbstractFileCollection.this.getFiles());
files.removeAll(collection.getFiles());
return files;
}
};
}
public FileCollection add(FileCollection collection) throws UnsupportedOperationException {
throw new UnsupportedOperationException(String.format("%s does not allow modification.", getCapDisplayName()));
}
public void addToAntBuilder(Object builder, String nodeName, AntType type) {
if (type == AntType.ResourceCollection) {
addAsResourceCollection(builder, nodeName);
}
else if (type == AntType.FileSet) {
addAsFileSet(builder, nodeName);
}
else {
addAsMatchingTask(builder, nodeName);
}
}
protected void addAsMatchingTask(Object builder, String nodeName) {
new AntFileCollectionMatchingTaskBuilder(getAsFileTrees()).addToAntBuilder(builder, nodeName);
}
protected void addAsFileSet(Object builder, String nodeName) {
for (DefaultConfigurableFileTree fileTree : getAsFileTrees()) {
fileTree.addToAntBuilder(builder, nodeName, AntType.FileSet);
}
}
protected void addAsResourceCollection(Object builder, String nodeName) {
new AntFileCollectionBuilder(this).addToAntBuilder(builder, nodeName);
}
/**
* Returns this collection as a set of {@link DefaultConfigurableFileTree} instances.
*/
protected Collection<DefaultConfigurableFileTree> getAsFileTrees() {
List<DefaultConfigurableFileTree> fileTrees = new ArrayList<DefaultConfigurableFileTree>();
for (File file : getFiles()) {
if (file.isFile()) {
DefaultConfigurableFileTree fileTree = new DefaultConfigurableFileTree(file.getParentFile(), null, null);
fileTree.include(new String[]{file.getName()});
fileTrees.add(fileTree);
}
}
return fileTrees;
}
public Object addToAntBuilder(Object node, String childNodeName) {
addToAntBuilder(node, childNodeName, AntType.ResourceCollection);
return this;
}
public boolean isEmpty() {
return getFiles().isEmpty();
}
public FileCollection stopExecutionIfEmpty() {
if (isEmpty()) {
throw new StopExecutionException(String.format("%s does not contain any files.", getCapDisplayName()));
}
return this;
}
public Object asType(Class<?> type) throws UnsupportedOperationException {
if (type.isAssignableFrom(Set.class)) {
return getFiles();
}
if (type.isAssignableFrom(List.class)) {
return new ArrayList<File>(getFiles());
}
if (type.isAssignableFrom(File[].class)) {
Set<File> files = getFiles();
return files.toArray(new File[files.size()]);
}
if (type.isAssignableFrom(File.class)) {
return getSingleFile();
}
if (type.isAssignableFrom(FileCollection.class)) {
return this;
}
if (type.isAssignableFrom(FileTree.class)) {
return getAsFileTree();
}
throw new UnsupportedOperationException(String.format(
"Cannot convert %s to type %s, as this type is not supported.", getDisplayName(),
type.getSimpleName()));
}
public TaskDependency getBuildDependencies() {
return new DefaultTaskDependency();
}
public FileTree getAsFileTree() {
return new CompositeFileTree() {
@Override
public TaskDependency getBuildDependencies() {
return AbstractFileCollection.this.getBuildDependencies();
}
@Override
protected void addSourceCollections(Collection<FileCollection> sources) {
TaskDependency taskDependency = AbstractFileCollection.this.getBuildDependencies();
for (File file : AbstractFileCollection.this.getFiles()) {
sources.add(new SingletonFileTree(file, taskDependency));
}
}
@Override
public String getDisplayName() {
return AbstractFileCollection.this.getDisplayName();
}
};
}
public FileCollection filter(Closure filterClosure) {
return filter(Specs.convertClosureToSpec(filterClosure));
}
public FileCollection filter(final Spec<? super File> filterSpec) {
return new AbstractFileCollection() {
@Override
public String getDisplayName() {
return AbstractFileCollection.this.getDisplayName();
}
@Override
public TaskDependency getBuildDependencies() {
return AbstractFileCollection.this.getBuildDependencies();
}
public Set<File> getFiles() {
return Specs.filterIterable(AbstractFileCollection.this, filterSpec);
}
};
}
protected String getCapDisplayName() {
return StringUtils.capitalize(getDisplayName());
}
}