Documentation  › org.apache.lucene.store  › RAMDirectory
 
 


  RAMDirectory
  public final

  Inherits From:   Directory : Object
  Conforms To:   none
  Declared In:   org.apache.lucene.store


Class Description
 
A memory-resident Directory implementation.


Class Variables
 
None declared in this class.


Instance Variables
 
None declared in this class.


Constructors
 
RAMDirectory
public RAMDirectory( )

Constructs an empty Directory.


RAMDirectory
public RAMDirectory( Directory dir ) throws IOException

Creates a new RAMDirectory instance from a different Directory implementation. This can be used to load a disk-based index into memory.

This should be used only with indices that can fit into memory.


RAMDirectory
public RAMDirectory( File dir ) throws IOException

Creates a new RAMDirectory instance from the FSDirectory.


RAMDirectory
public RAMDirectory( String dir ) throws IOException

Creates a new RAMDirectory instance from the FSDirectory.



Class Methods
 
None declared in this class.


Instance Methods
 
close
public final void close( )

Closes the store to future operations.


createFile
public final OutputStream createFile( String name )

Creates a new, empty file in the directory with the given name. Returns a stream writing this file.


deleteFile
public final void deleteFile( String name )

Removes an existing file in the directory.


fileExists
public final boolean fileExists( String name )

Returns true iff the named file exists in this directory.


fileLength
public final long fileLength( String name )

Returns the length in bytes of a file in the directory.


fileModified
public final long fileModified( String name ) throws IOException

Returns the time the named file was last modified.


list
public final String[] list( )

Returns an array of strings, one for each file in the directory.


makeLock
public final Lock makeLock( String name )

Construct a Lock.


openFile
public final InputStream openFile( String name )

Returns a stream reading an existing file.


renameFile
public final void renameFile( String from, String to )

Removes an existing file in the directory.


touchFile
public void touchFile( String name ) throws IOException

Set the modified time of an existing file to now.


Known Subclasses
 
None.



 
 
  dydoc
  3/9/05