Class FilterDirectory

Directory implementation that delegates calls to another directory. This class can be used to add limitations on top of an existing Directory implementation such as rate limiting (RateLimitedDirectoryWrapper) or to add additional sanity checks for tests. However, if you plan to write your own Directory implementation, you should consider extending directly Directory or BaseDirectory rather than try to reuse functionality of existing Directorys by extending this class.

This is a Lucene.NET INTERNAL API, use at your own risk
Inheritance
System.Object
Directory
FilterDirectory
RateLimitedDirectoryWrapper
TrackingDirectoryWrapper
Implements
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Lucene.Net.Store
Assembly: Lucene.Net.dll
Syntax
public class FilterDirectory : Directory, IDisposable

Constructors

| Improve this Doc View Source

FilterDirectory(Directory)

Sole constructor, typically called from sub-classes.

Declaration
protected FilterDirectory(Directory in)
Parameters
Type Name Description
Directory in

Fields

| Improve this Doc View Source

m_input

Declaration
protected readonly Directory m_input
Field Value
Type Description
Directory

Properties

| Improve this Doc View Source

Delegate

Return the wrapped Directory.

Declaration
public Directory Delegate { get; }
Property Value
Type Description
Directory
| Improve this Doc View Source

LockFactory

Declaration
public override LockFactory LockFactory { get; }
Property Value
Type Description
LockFactory
Overrides

Methods

| Improve this Doc View Source

ClearLock(String)

Declaration
public override void ClearLock(string name)
Parameters
Type Name Description
System.String name
Overrides
| Improve this Doc View Source

CreateOutput(String, IOContext)

Declaration
public override IndexOutput CreateOutput(string name, IOContext context)
Parameters
Type Name Description
System.String name
IOContext context
Returns
Type Description
IndexOutput
Overrides
| Improve this Doc View Source

DeleteFile(String)

Declaration
public override void DeleteFile(string name)
Parameters
Type Name Description
System.String name
Overrides
| Improve this Doc View Source

Dispose(Boolean)

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing
Overrides
| Improve this Doc View Source

FileExists(String)

Declaration
[Obsolete("this method will be removed in 5.0")]
public override bool FileExists(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Boolean
Overrides
| Improve this Doc View Source

FileLength(String)

Declaration
public override long FileLength(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Int64
Overrides
| Improve this Doc View Source

GetLockID()

Declaration
public override string GetLockID()
Returns
Type Description
System.String
Overrides
| Improve this Doc View Source

ListAll()

Declaration
public override string[] ListAll()
Returns
Type Description
System.String[]
Overrides
| Improve this Doc View Source

MakeLock(String)

Declaration
public override Lock MakeLock(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
Lock
Overrides
| Improve this Doc View Source

OpenInput(String, IOContext)

Declaration
public override IndexInput OpenInput(string name, IOContext context)
Parameters
Type Name Description
System.String name
IOContext context
Returns
Type Description
IndexInput
Overrides
| Improve this Doc View Source

SetLockFactory(LockFactory)

Declaration
public override void SetLockFactory(LockFactory lockFactory)
Parameters
Type Name Description
LockFactory lockFactory
Overrides
| Improve this Doc View Source

Sync(ICollection<String>)

Declaration
public override void Sync(ICollection<string> names)
Parameters
Type Name Description
System.Collections.Generic.ICollection<System.String> names
Overrides
| Improve this Doc View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides

Implements

System.IDisposable