Class CompoundDirectory

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable
    Direct Known Subclasses:
    Lucene50CompoundReader

    public abstract class CompoundDirectory
    extends Directory
    A read-only Directory that consists of a view over a compound file.
    See Also:
    CompoundFormat
    • Constructor Detail

      • CompoundDirectory

        protected CompoundDirectory()
        Sole constructor.
    • Method Detail

      • checkIntegrity

        public abstract void checkIntegrity()
                                     throws java.io.IOException
        Checks consistency of this directory.

        Note that this may be costly in terms of I/O, e.g. may involve computing a checksum value against large data files.

        Throws:
        java.io.IOException
      • deleteFile

        public final void deleteFile​(java.lang.String name)
        Not implemented
        Specified by:
        deleteFile in class Directory
        Parameters:
        name - the name of an existing file.
        Throws:
        java.lang.UnsupportedOperationException - always: not supported by CFS
      • rename

        public final void rename​(java.lang.String from,
                                 java.lang.String to)
        Not implemented
        Specified by:
        rename in class Directory
        Throws:
        java.lang.UnsupportedOperationException - always: not supported by CFS
      • createOutput

        public final IndexOutput createOutput​(java.lang.String name,
                                              IOContext context)
                                       throws java.io.IOException
        Description copied from class: Directory
        Creates a new, empty file in the directory and returns an IndexOutput instance for appending data to this file. This method must throw FileAlreadyExistsException if the file already exists.
        Specified by:
        createOutput in class Directory
        Parameters:
        name - the name of the file to create.
        Throws:
        java.io.IOException - in case of I/O error
      • createTempOutput

        public final IndexOutput createTempOutput​(java.lang.String prefix,
                                                  java.lang.String suffix,
                                                  IOContext context)
                                           throws java.io.IOException
        Description copied from class: Directory
        Creates a new, empty, temporary file in the directory and returns an IndexOutput instance for appending data to this file. The temporary file name (accessible via IndexOutput.getName()) will start with prefix, end with suffix and have a reserved file extension .tmp.
        Specified by:
        createTempOutput in class Directory
        Throws:
        java.io.IOException
      • sync

        public final void sync​(java.util.Collection<java.lang.String> names)
        Description copied from class: Directory
        Ensures that any writes to these files are moved to stable storage (made durable). Lucene uses this to properly commit changes to the index, to prevent a machine/OS crash from corrupting the index.
        Specified by:
        sync in class Directory
        See Also:
        Directory.syncMetaData()
      • obtainLock

        public final Lock obtainLock​(java.lang.String name)
        Description copied from class: Directory
        Acquires and returns a Lock for a file with the given name.
        Specified by:
        obtainLock in class Directory
        Parameters:
        name - the name of the lock file