ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dona...@apache.org
Subject cvs commit: jakarta-ant/proposal/myrmidon/src/main/org/apache/tools/ant/taskdefs/file Delete.java
Date Sun, 03 Feb 2002 07:10:01 GMT
donaldp     02/02/02 23:10:01

  Added:       proposal/myrmidon/src/java/org/apache/antlib/file
                        Delete.java
  Removed:     proposal/myrmidon/src/main/org/apache/tools/ant/taskdefs/file
                        Delete.java
  Log:
  Move the delete, touch and mkdir tasks into antlib. CLean and refactor each task to make
sure is closer to code-normalized. Also make sure all the messages are capable of being i18n'ed
  
  Revision  Changes    Path
  1.1                  jakarta-ant/proposal/myrmidon/src/java/org/apache/antlib/file/Delete.java
  
  Index: Delete.java
  ===================================================================
  /*
   * Copyright (C) The Apache Software Foundation. All rights reserved.
   *
   * This software is published under the terms of the Apache Software License
   * version 1.1, a copy of which has been included with this distribution in
   * the LICENSE.txt file.
   */
  package org.apache.antlib.file;
  
  import java.io.File;
  import java.util.ArrayList;
  import org.apache.avalon.excalibur.i18n.ResourceManager;
  import org.apache.avalon.excalibur.i18n.Resources;
  import org.apache.myrmidon.api.AbstractTask;
  import org.apache.myrmidon.api.TaskException;
  import org.apache.tools.ant.types.DirectoryScanner;
  import org.apache.tools.ant.types.FileSet;
  import org.apache.tools.ant.types.ScannerUtil;
  
  /**
   * Deletes a file or directory, or set of files defined by a fileset.
   *
   * @ant:task name="delete"
   * @author <a href="mailto:peter@apache.org">Peter Donald</a>
   * @author <a href="mailto:stefano@apache.org">Stefano Mazzocchi</a>
   * @author <a href="mailto:tad1@cornell.edu">Tom Dimock</a>
   * @author <a href="mailto:glennm@ca.ibm.com">Glenn McAllister</a>
   * @author <a href="mailto:jon@latchkey.com">Jon S. Stevens</a>
   * @version $Revision: 1.1 $ $Date: 2002/02/03 07:10:01 $
   */
  public class Delete
      extends AbstractTask
  {
      private final static Resources REZ =
          ResourceManager.getPackageResources( Delete.class );
  
      private final ArrayList filesets = new ArrayList();
      private File m_dir;
      private File m_file;
      private boolean m_includeEmpty;// by default, remove matching empty dirs
  
      /**
       * Set the directory from which files are to be deleted
       *
       * @param dir the directory path.
       */
      public void setDir( final File dir )
      {
          m_dir = dir;
      }
  
      /**
       * Set the name of a single file to be removed.
       *
       * @param file the file to be deleted
       */
      public void setFile( final File file )
      {
          m_file = file;
      }
  
      /**
       * Adds a set of files (nested fileset attribute).
       */
      public void addFileset( FileSet set )
      {
          filesets.add( set );
      }
  
      /**
       * Delete the file(s).
       */
      public void execute()
          throws TaskException
      {
          validate();
  
          // delete the single file
          if( null != m_file && m_file.exists() )
          {
              deleteFile( m_file );
          }
  
          // delete the directory
          if( m_dir != null && m_dir.exists() && m_dir.isDirectory() )
          {
              final String message =
                  REZ.getString( "delete.delete-dir.notice", m_dir.getAbsolutePath() );
              getLogger().info( message );
              deleteDir( m_dir );
          }
  
          // delete the files in the filesets
          final int size = filesets.size();
          for( int i = 0; i < size; i++ )
          {
              final FileSet fileSet = (FileSet)filesets.get( i );
              final DirectoryScanner scanner =
                  ScannerUtil.getDirectoryScanner( fileSet );
              final String[] files = scanner.getIncludedFiles();
              final String[] dirs = scanner.getIncludedDirectories();
              removeFiles( fileSet.getDir(), files, dirs );
          }
      }
  
      private void validate()
          throws TaskException
      {
          if( null == m_file && null == m_dir && 0 == filesets.size() )
          {
              final String message = REZ.getString( "delete.nofiles.error" );
              throw new TaskException( message );
          }
  
          if( null != m_file && m_file.exists() && m_file.isDirectory() )
          {
              final String message =
                  REZ.getString( "delete.bad-file.error", m_file.getAbsolutePath() );
              throw new TaskException( message );
          }
  
          if( null != m_file && !m_file.exists() )
          {
              final String message =
                  REZ.getString( "delete.missing-file.error", m_file.getAbsolutePath() );
              getLogger().debug( message );
          }
      }
  
      private void deleteDir( final File baseDir )
          throws TaskException
      {
          final File[] list = baseDir.listFiles();
          if( list != null )
          {
              deleteFiles( list );
          }
  
          if( getLogger().isDebugEnabled() )
          {
              final String message =
                  REZ.getString( "delete.delete-dir.notice", m_dir.getAbsolutePath() );
              getLogger().debug( message );
          }
  
          if( !baseDir.delete() )
          {
              final String message =
                  REZ.getString( "delete.delete-dir.error", m_dir.getAbsolutePath() );
              throw new TaskException( message );
          }
      }
  
      private void deleteFiles( final File[] list )
          throws TaskException
      {
          for( int i = 0; i < list.length; i++ )
          {
              final File file = list[ i ];
              if( file.isDirectory() )
              {
                  deleteDir( file );
              }
              else
              {
                  deleteFile( file );
              }
          }
      }
  
      private void deleteFile( final File file )
          throws TaskException
      {
          if( getLogger().isDebugEnabled() )
          {
              final String message =
                  REZ.getString( "delete.delete-file.notice", file.getAbsolutePath() );
              getLogger().debug( message );
          }
  
          if( !file.delete() )
          {
              final String message =
                  REZ.getString( "delete.delete-file.error", file.getAbsolutePath() );
              throw new TaskException( message );
          }
      }
  
      /**
       * remove an array of files in a directory, and a list of subdirectories
       * which will only be deleted if 'includeEmpty' is true
       *
       * @param d directory to work from
       * @param files array of files to delete; can be of zero length
       * @param dirs array of directories to delete; can of zero length
       */
      protected void removeFiles( final File baseDir,
                                  final String[] files,
                                  final String[] dirs )
          throws TaskException
      {
          if( files.length > 0 )
          {
              final String message =
                  REZ.getString( "delete.delete-file.error",
                                 new Integer( files.length ),
                                 baseDir.getAbsolutePath() );
              getLogger().info( message );
              for( int i = 0; i < files.length; i++ )
              {
                  final File file = new File( baseDir, files[ i ] );
                  deleteFile( file );
              }
          }
  
          if( dirs.length > 0 && m_includeEmpty )
          {
              int dirCount = 0;
              for( int j = dirs.length - 1; j >= 0; j-- )
              {
                  final File dir = new File( baseDir, dirs[ j ] );
                  final String[] dirFiles = dir.list();
                  if( null == dirFiles || 0 == dirFiles.length )
                  {
                      deleteDir( dir );
                      dirCount++;
                  }
              }
  
              if( dirCount > 0 )
              {
                  final String message =
                      REZ.getString( "delete.summary.notice",
                                     new Integer( dirCount ),
                                     baseDir.getAbsolutePath() );
                  getLogger().info( message );
              }
          }
      }
  }
  
  
  
  

--
To unsubscribe, e-mail:   <mailto:ant-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:ant-dev-help@jakarta.apache.org>


Mime
View raw message