/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.commons.vfs2.tasks;

import java.util.StringTokenizer;

import org.apache.commons.vfs2.FileObject;
import org.apache.commons.vfs2.util.Messages;
import org.apache.tools.ant.BuildException;

An Ant task that deletes matching files.

TOOD - Allow selector to be specified.

/** * An Ant task that deletes matching files. * <p> * TOOD - Allow selector to be specified. * </p> */
public class DeleteTask extends VfsTask { private String file; private String srcDirUrl; private String filesList;
Sets the file/folder to delete.
Params:
  • file – The name of the file.
/** * Sets the file/folder to delete. * * @param file The name of the file. */
public void setFile(final String file) { this.file = file; }
Sets the source directory.
Params:
  • srcDir – The source directory.
/** * Sets the source directory. * * @param srcDir The source directory. */
public void setSrcDir(final String srcDir) { this.srcDirUrl = srcDir; }
Sets the files to include.
Params:
  • filesList – The list of files.
/** * Sets the files to include. * * @param filesList The list of files. */
public void setIncludes(final String filesList) { this.filesList = filesList; }
Executes this task.
Throws:
  • BuildException – if an error occurs.
/** * Executes this task. * * @throws BuildException if an error occurs. */
@Override public void execute() throws BuildException { if ((file == null && srcDirUrl == null) || (srcDirUrl != null && filesList == null)) { final String message = Messages.getString("vfs.tasks/delete.no-source-files.error"); throw new BuildException(message); } try { if (srcDirUrl != null && filesList != null) { log("Deleting " + filesList + " in the directory " + srcDirUrl); if (!srcDirUrl.endsWith("/")) { srcDirUrl += "/"; } final StringTokenizer tok = new StringTokenizer(filesList, ", \t\n\r\f", false); while (tok.hasMoreTokens()) { final String nextFile = tok.nextToken(); final FileObject srcFile = resolveFile(srcDirUrl + nextFile); srcFile.deleteAll(); } } else { final FileObject srcFile = resolveFile(file); log("Deleting " + srcFile.getPublicURIString()); srcFile.deleteAll(); } } catch (final Exception e) { throw new BuildException(e); } } }