source/mir/changetracker/ChangeReporter.java

   1 /*
   2  * Copyright (C) 2001, 2002 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  * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library
  23  * (or with modified versions of the above that use the same license as the above),
  24  * and distribute linked combinations including the two.  You must obey the
  25  * GNU General Public License in all respects for all of the code used other than
  26  * the above mentioned libraries.  If you modify this file, you may extend this
  27  * exception to your version of the file, but you are not obligated to do so.
  28  * If you do not wish to do so, delete this exception statement from your version.
  29  */
  30 package mir.changetracker;
  31
  32 import mir.util.LockFile;
  33
  34 import java.io.File;
  35 import java.io.FileWriter;
  36 import java.io.IOException;
  37 import java.util.Iterator;
  38 import java.util.List;
  39
  40 /**
  41  * Class to report changes by writing to a file and using a lockfile.
  42  *
  43  * This class is NOT thread-safe, the perform() method should not be called
  44  * concurrently.
  45  */
  46 public class ChangeReporter {
  47   public static void reportChanges(
  48       ChangeTracker aTracker, String aBasePath,
  49       List anExcludedPaths, File aReportFilename,
  50       File aReportLockfile, long aMaxTimeOut, boolean aFlush) throws IOException {
  51
  52     reportChanges(aTracker, aBasePath,
  53         (String[]) anExcludedPaths.toArray(new String[0]),
  54         aReportFilename, aReportLockfile, aMaxTimeOut, aFlush);
  55   }
  56
  57   /**
  58    * @param aBasePath        The base path that should be tracked
  59    * @param anExcludedPaths  The paths that are excluded from tracking
  60    * @param aTracker         The actual tracker to query for changes
  61    * @param aReportFilename  The file to write changed filenames to
  62    * @param aReportLockfile  The lockfile for the report file
  63    */
  64   public static void reportChanges(ChangeTracker aTracker, String aBasePath,
  65                                    String[] anExcludedPaths, File aReportFilename, File aReportLockfile,
  66                                    long aMaxTimeOut, boolean aFlush) throws IOException {
  67     List changesToReport = aTracker.getChanges(aBasePath, anExcludedPaths);
  68     LockFile lockFile = null;
  69
  70     if (aReportLockfile!=null)
  71       lockFile = new LockFile(aReportLockfile);
  72
  73     if (changesToReport.size()>0) {
  74       if (lockFile == null || lockFile.lock()) {
  75         try {
  76           FileWriter writer = new FileWriter(aReportFilename.getAbsolutePath(), true);
  77           try {
  78             Iterator i = changesToReport.iterator();
  79             while (i.hasNext()) {
  80               writer.write((String) i.next());
  81               writer.write("\n");
  82             }
  83           }
  84           finally {
  85             try {
  86               writer.close();
  87             }
  88             catch (Throwable t) {
  89             }
  90           }
  91
  92           if (aFlush) {
  93             aTracker.clearChanges(changesToReport);
  94           }
  95         }
  96         finally {
  97           try {
  98             if (lockFile!=null)
  99               lockFile.unlock();
 100           }
 101           catch (Throwable t) {
 102           }
 103         }
 104       }
 105     }
 106   }
 107 }