Package org.apache.lucene.store

Class SingleInstanceLockFactory

  • public class SingleInstanceLockFactory
extends LockFactory
    Implements LockFactory for a single in-process instance, meaning all locking will take place through this one instance. Only use this LockFactory when you are certain all IndexReaders and IndexWriters for a given index are running against a single shared in-process Directory instance. This is currently the default locking for RAMDirectory.
    See Also:
    LockFactory

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void clearLock​(java.lang.String lockName)
      Attempt to clear (forcefully unlock and remove) the specified lock.
      Lock makeLock​(java.lang.String lockName)
      Return a new Lock instance identified by lockName.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • SingleInstanceLockFactory

        public SingleInstanceLockFactory()

    • Method Detail

      • makeLock

        public Lock makeLock​(java.lang.String lockName)
        Description copied from class: LockFactory
        Return a new Lock instance identified by lockName.
        Specified by:
        makeLock in class LockFactory
        Parameters:
        lockName - name of the lock to be created.

      • clearLock

        public void clearLock​(java.lang.String lockName)
               throws java.io.IOException
        Description copied from class: LockFactory
        Attempt to clear (forcefully unlock and remove) the specified lock. Only call this at a time when you are certain this lock is no longer in use.
        Specified by:
        clearLock in class LockFactory
        Parameters:
        lockName - name of the lock to be cleared.
        Throws:
        java.io.IOException