org.apache.lucene.store

Class TestHelper

java.lang.Object

org.apache.lucene.store.TestHelper

public final class TestHelper
extends Object

This class provides access to package-level features defined in the store package. It is used for testing only.

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	isSimpleFSIndexInput(IndexInput is) Returns true if the instance of the provided input stream is actually an SimpleFSIndexInput.
static boolean	isSimpleFSIndexInputClone(IndexInput is) Returns true if the provided input stream is an SimpleFSIndexInput and is a clone, that is it does not own its underlying file descriptor.
static boolean	isSimpleFSIndexInputOpen(IndexInput is) Given an instance of SimpleFSDirectory.SimpleFSIndexInput, this method returns true if the underlying file descriptor is valid, and false otherwise.

Methods inherited from class java.lang.Object

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

Method Detail

isSimpleFSIndexInput

public static boolean isSimpleFSIndexInput(IndexInput is)

Returns true if the instance of the provided input stream is actually an SimpleFSIndexInput.

isSimpleFSIndexInputClone

public static boolean isSimpleFSIndexInputClone(IndexInput is)

Returns true if the provided input stream is an SimpleFSIndexInput and is a clone, that is it does not own its underlying file descriptor.

isSimpleFSIndexInputOpen

public static boolean isSimpleFSIndexInputOpen(IndexInput is)
                                        throws IOException

Given an instance of SimpleFSDirectory.SimpleFSIndexInput, this method returns true if the underlying file descriptor is valid, and false otherwise. This can be used to determine if the OS file has been closed. The descriptor becomes invalid when the non-clone instance of the SimpleFSIndexInput that owns this descriptor is closed. However, the descriptor may possibly become invalid in other ways as well.

Throws:

IOException