source/mir/changetracker/ChangeReporter.java

   1 /*
   2  * Copyright (C) 2001-2006 The Mir-coders group
   3  *
   4  * This file is part of Mir.
   5  *
   6  * Mir is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * Mir is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with Mir; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  * In addition, as a special exception, The Mir-coders gives permission to link
  21  * the code of this program with  any library licensed under the Apache Software License,
  22  * and distribute linked combinations including the two.  You must obey the
  23  * GNU General Public License in all respects for all of the code used other than
  24  * the above mentioned libraries.  If you modify this file, you may extend this
  25  * exception to your version of the file, but you are not obligated to do so.
  26  * If you do not wish to do so, delete this exception statement from your version.
  27  */package mir.changetracker;
  28
  29 import mir.util.LockFile;
  30
  31 import java.io.File;
  32 import java.io.FileWriter;
  33 import java.io.IOException;
  34 import java.util.Iterator;
  35 import java.util.List;
  36
  37 /**
  38  * Class to report changes by writing to a file and using a lockfile.
  39  *
  40  * This class is NOT thread-safe, the perform() method should not be called
  41  * concurrently.
  42  */
  43 public class ChangeReporter {
  44   public static void reportChanges(
  45       ChangeTracker aTracker, String aBasePath,
  46       List anExcludedPaths, File aReportFilename,
  47       File aReportLockfile, long aMaxTimeOut, boolean aFlush) throws IOException {
  48
  49     reportChanges(aTracker, aBasePath,
  50         (String[]) anExcludedPaths.toArray(new String[0]),
  51         aReportFilename, aReportLockfile, aMaxTimeOut, aFlush);
  52   }
  53
  54   /**
  55    * @param aBasePath        The base path that should be tracked
  56    * @param anExcludedPaths  The paths that are excluded from tracking
  57    * @param aTracker         The actual tracker to query for changes
  58    * @param aReportFilename  The file to write changed filenames to
  59    * @param aReportLockfile  The lockfile for the report file
  60    */
  61   public static void reportChanges(ChangeTracker aTracker, String aBasePath,
  62                                    String[] anExcludedPaths, File aReportFilename, File aReportLockfile,
  63                                    long aMaxTimeOut, boolean aFlush) throws IOException {
  64     List changesToReport = aTracker.getChanges(aBasePath, anExcludedPaths);
  65     LockFile lockFile = null;
  66
  67     if (aReportLockfile!=null)
  68       lockFile = new LockFile(aReportLockfile);
  69
  70     if (changesToReport.size()>0) {
  71       if (lockFile == null || lockFile.lock()) {
  72         try {
  73           FileWriter writer = new FileWriter(aReportFilename.getAbsolutePath(), true);
  74           try {
  75             Iterator i = changesToReport.iterator();
  76             while (i.hasNext()) {
  77               writer.write((String) i.next());
  78               writer.write("\n");
  79             }
  80           }
  81           finally {
  82             try {
  83               writer.close();
  84             }
  85             catch (Throwable t) {
  86             }
  87           }
  88
  89           if (aFlush) {
  90             aTracker.clearChanges(changesToReport);
  91           }
  92         }
  93         finally {
  94           try {
  95             if (lockFile!=null)
  96               lockFile.unlock();
  97           }
  98           catch (Throwable t) {
  99           }
 100         }
 101       }
 102     }
 103   }
 104 }