lucene-java-3.4.0/lucene/src/java/org/apache/lucene/store/FSLockFactory.java

   1 package org.apache.lucene.store;
   2
   3 /**
   4  * Licensed to the Apache Software Foundation (ASF) under one or more
   5  * contributor license agreements.  See the NOTICE file distributed with
   6  * this work for additional information regarding copyright ownership.
   7  * The ASF licenses this file to You under the Apache License, Version 2.0
   8  * (the "License"); you may not use this file except in compliance with
   9  * the License.  You may obtain a copy of the License at
  10  *
  11  *     http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  */
  19
  20 import java.io.File;
  21
  22 /**
  23  * Base class for file system based locking implementation.
  24  */
  25
  26 public abstract class FSLockFactory extends LockFactory {
  27
  28   /**
  29    * Directory for the lock files.
  30    */
  31   protected File lockDir = null;
  32
  33   /**
  34    * Set the lock directory. This method can be only called
  35    * once to initialize the lock directory. It is used by {@link FSDirectory}
  36    * to set the lock directory to itself.
  37    * Subclasses can also use this method to set the directory
  38    * in the constructor.
  39    */
  40   protected final void setLockDir(File lockDir) {
  41     if (this.lockDir != null)
  42       throw new IllegalStateException("You can set the lock directory for this factory only once.");
  43     this.lockDir = lockDir;
  44   }
  45
  46   /**
  47    * Retrieve the lock directory.
  48    */
  49   public File getLockDir() {
  50     return lockDir;
  51   }
  52
  53 }