lucene-java-3.4.0/lucene/src/java/org/apache/lucene/store/NoLockFactory.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.IOException;
  21
  22 /**
  23  * Use this {@link LockFactory} to disable locking entirely.
  24  * Only one instance of this lock is created.  You should call {@link
  25  * #getNoLockFactory()} to get the instance.
  26  *
  27  * @see LockFactory
  28  */
  29
  30 public class NoLockFactory extends LockFactory {
  31
  32   // Single instance returned whenever makeLock is called.
  33   private static NoLock singletonLock = new NoLock();
  34   private static NoLockFactory singleton = new NoLockFactory();
  35
  36   /**
  37    * @deprecated This constructor was not intended to be public and should not be used.
  38    *  It will be made private in Lucene 4.0
  39    * @see #getNoLockFactory()
  40    */
  41   // make private in 4.0!
  42   @Deprecated
  43   public NoLockFactory() {}
  44
  45   public static NoLockFactory getNoLockFactory() {
  46     return singleton;
  47   }
  48
  49   @Override
  50   public Lock makeLock(String lockName) {
  51     return singletonLock;
  52   }
  53
  54   @Override
  55   public void clearLock(String lockName) {}
  56 }
  57
  58 class NoLock extends Lock {
  59   @Override
  60   public boolean obtain() throws IOException {
  61     return true;
  62   }
  63
  64   @Override
  65   public void release() {
  66   }
  67
  68   @Override
  69   public boolean isLocked() {
  70     return false;
  71   }
  72
  73   @Override
  74   public String toString() {
  75     return "NoLock";
  76   }
  77 }