|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.lucene.store.Directory
org.apache.lucene.store.MockDirectoryWrapper
public class MockDirectoryWrapper
This is a Directory Wrapper that adds methods intended to be used only by unit tests. It also adds a number of features useful for testing:
LuceneTestCase.newDirectory() are tracked
to ensure they are closed by the test.
| Nested Class Summary | |
|---|---|
static class |
MockDirectoryWrapper.Failure
Objects that represent fail-able conditions. |
static class |
MockDirectoryWrapper.Throttling
|
| Field Summary |
|---|
| Fields inherited from class org.apache.lucene.store.Directory |
|---|
isOpen, lockFactory |
| Constructor Summary | |
|---|---|
MockDirectoryWrapper(Random random,
org.apache.lucene.store.Directory delegate)
|
|
| Method Summary | |
|---|---|
void |
clearCrash()
|
void |
clearLock(String name)
|
void |
close()
|
void |
copy(org.apache.lucene.store.Directory to,
String src,
String dest)
|
void |
crash()
Simulates a crash of OS or machine by overwriting unsynced files. |
org.apache.lucene.store.IndexOutput |
createOutput(String name)
|
void |
deleteFile(String name)
|
void |
failOn(MockDirectoryWrapper.Failure fail)
add a Failure object to the list of objects to be evaluated at every potential failure point |
boolean |
fileExists(String name)
|
long |
fileLength(String name)
|
long |
fileModified(String name)
|
boolean |
getCheckIndexOnClose()
|
int |
getInputCloneCount()
|
org.apache.lucene.store.LockFactory |
getLockFactory()
|
String |
getLockID()
|
long |
getMaxSizeInBytes()
|
long |
getMaxUsedSizeInBytes()
Returns the peek actual storage used (bytes) in this directory. |
boolean |
getNoDeleteOpenFile()
|
Set<String> |
getOpenDeletedFiles()
|
double |
getRandomIOExceptionRate()
|
long |
getRecomputedActualSizeInBytes()
Like getRecomputedSizeInBytes(), but, uses actual file lengths rather than buffer allocations (which are quantized up to nearest RAMOutputStream.BUFFER_SIZE (now 1024) bytes. |
long |
getRecomputedSizeInBytes()
Provided for testing purposes. |
boolean |
isOpen()
|
String[] |
listAll()
|
org.apache.lucene.store.Lock |
makeLock(String name)
|
org.apache.lucene.store.IndexInput |
openInput(String name)
|
void |
removeIndexInput(org.apache.lucene.store.IndexInput in,
String name)
|
void |
removeIndexOutput(org.apache.lucene.store.IndexOutput out,
String name)
|
void |
resetMaxUsedSizeInBytes()
|
void |
setAssertNoUnrefencedFilesOnClose(boolean v)
|
void |
setCheckIndexOnClose(boolean value)
Set whether or not checkindex should be run on close |
void |
setFailOnCreateOutput(boolean v)
|
void |
setFailOnOpenInput(boolean v)
|
void |
setLockFactory(org.apache.lucene.store.LockFactory lockFactory)
|
void |
setMaxSizeInBytes(long maxSize)
|
void |
setNoDeleteOpenFile(boolean value)
Emulate windows whereby deleting an open file is not allowed (raise IOException). |
void |
setPreventDoubleWrite(boolean value)
If set to true, we throw an IOException if the same file is opened by createOutput, ever. |
void |
setRandomIOExceptionRate(double rate)
If 0.0, no exceptions will be thrown. |
void |
setThrottling(MockDirectoryWrapper.Throttling throttling)
|
void |
setTrackDiskUsage(boolean v)
|
long |
sizeInBytes()
|
void |
sync(Collection<String> names)
|
void |
sync(String name)
Deprecated. |
String |
toString()
|
void |
touchFile(String name)
Deprecated. |
| Methods inherited from class org.apache.lucene.store.Directory |
|---|
copy, ensureOpen, openInput |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public MockDirectoryWrapper(Random random,
org.apache.lucene.store.Directory delegate)
| Method Detail |
|---|
public int getInputCloneCount()
public void setTrackDiskUsage(boolean v)
public void setPreventDoubleWrite(boolean value)
@Deprecated
public void sync(String name)
throws IOException
sync in class org.apache.lucene.store.DirectoryIOExceptionpublic void setThrottling(MockDirectoryWrapper.Throttling throttling)
public void sync(Collection<String> names)
throws IOException
sync in class org.apache.lucene.store.DirectoryIOExceptionpublic String toString()
toString in class org.apache.lucene.store.Directory
public final long sizeInBytes()
throws IOException
IOException
public void crash()
throws IOException
IOException
public void clearCrash()
throws IOException
IOExceptionpublic void setMaxSizeInBytes(long maxSize)
public long getMaxSizeInBytes()
public long getMaxUsedSizeInBytes()
public void resetMaxUsedSizeInBytes()
throws IOException
IOExceptionpublic void setNoDeleteOpenFile(boolean value)
public boolean getNoDeleteOpenFile()
public void setCheckIndexOnClose(boolean value)
public boolean getCheckIndexOnClose()
public void setRandomIOExceptionRate(double rate)
public double getRandomIOExceptionRate()
public void deleteFile(String name)
throws IOException
deleteFile in class org.apache.lucene.store.DirectoryIOExceptionpublic Set<String> getOpenDeletedFiles()
public void setFailOnCreateOutput(boolean v)
public org.apache.lucene.store.IndexOutput createOutput(String name)
throws IOException
createOutput in class org.apache.lucene.store.DirectoryIOExceptionpublic void setFailOnOpenInput(boolean v)
public org.apache.lucene.store.IndexInput openInput(String name)
throws IOException
openInput in class org.apache.lucene.store.DirectoryIOException
public final long getRecomputedSizeInBytes()
throws IOException
IOException
public final long getRecomputedActualSizeInBytes()
throws IOException
IOExceptionpublic void setAssertNoUnrefencedFilesOnClose(boolean v)
public void close()
throws IOException
close in interface Closeableclose in class org.apache.lucene.store.DirectoryIOException
public void removeIndexOutput(org.apache.lucene.store.IndexOutput out,
String name)
public void removeIndexInput(org.apache.lucene.store.IndexInput in,
String name)
public boolean isOpen()
public void failOn(MockDirectoryWrapper.Failure fail)
public String[] listAll()
throws IOException
listAll in class org.apache.lucene.store.DirectoryIOException
public boolean fileExists(String name)
throws IOException
fileExists in class org.apache.lucene.store.DirectoryIOException
public long fileModified(String name)
throws IOException
fileModified in class org.apache.lucene.store.DirectoryIOException
@Deprecated
public void touchFile(String name)
throws IOException
touchFile in class org.apache.lucene.store.DirectoryIOException
public long fileLength(String name)
throws IOException
fileLength in class org.apache.lucene.store.DirectoryIOExceptionpublic org.apache.lucene.store.Lock makeLock(String name)
makeLock in class org.apache.lucene.store.Directory
public void clearLock(String name)
throws IOException
clearLock in class org.apache.lucene.store.DirectoryIOException
public void setLockFactory(org.apache.lucene.store.LockFactory lockFactory)
throws IOException
setLockFactory in class org.apache.lucene.store.DirectoryIOExceptionpublic org.apache.lucene.store.LockFactory getLockFactory()
getLockFactory in class org.apache.lucene.store.Directorypublic String getLockID()
getLockID in class org.apache.lucene.store.Directory
public void copy(org.apache.lucene.store.Directory to,
String src,
String dest)
throws IOException
copy in class org.apache.lucene.store.DirectoryIOException
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||