source/mir/util/LockFile.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.util;
  31
  32 import java.io.File;
  33 import java.io.IOException;
  34
  35 /**
  36  * Class to do locking by way of a file:
  37  * existence of the file means the lock is enabled.
  38  */
  39 public class LockFile {
  40   private File file;
  41
  42   /**
  43    * Creates an instance based on a filename
  44    */
  45   public LockFile(String aFileName) {
  46     file = new File(aFileName);
  47   }
  48
  49   public LockFile(File aFile) {
  50     file = new File(aFile.getAbsolutePath());
  51   }
  52
  53   /**
  54    * Tries to enable the lock. Returns <code>true</code> on success.
  55    */
  56   public boolean lock() throws IOException {
  57     if (file.createNewFile()) {
  58       file.deleteOnExit();
  59       return true;
  60     }
  61     else {
  62       return false;
  63     }
  64   }
  65
  66   /**
  67    * Returns <code>true</code> if locked, either by external parties
  68    * or by this object.
  69    */
  70   public boolean isLocked() {
  71     return file.exists();
  72   }
  73
  74   /**
  75    * Removes the lock, wether it was enabled by this object or by
  76    * an external party.
  77    */
  78   public void unlock() {
  79     file.delete();
  80   }
  81 }