Lucene.Net  3.0.3
Lucene.Net is a .NET port of the Java Lucene Indexing Library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties
Public Member Functions | Protected Member Functions | Properties | List of all members
Lucene.Net.Store.BufferedIndexOutput Class Referenceabstract

Base implementation class for buffered IndexOutput. More...

Inherits Lucene.Net.Store.IndexOutput.

Inherited by Lucene.Net.Store.SimpleFSDirectory.SimpleFSIndexOutput.

Public Member Functions

override void WriteByte (byte b)
 Writes a single byte.
 
override void WriteBytes (byte[] b, int offset, int length)
 Writes an array of bytes.
 
override void Flush ()
 Forces any buffered output to be written.
 
abstract void FlushBuffer (byte[] b, int offset, int len)
 Expert: implements buffer write. Writes bytes at the current position in the output.
 
override void Seek (long pos)
 Sets current position in this file, where the next write will occur.
 
- Public Member Functions inherited from Lucene.Net.Store.IndexOutput
virtual void WriteBytes (byte[] b, int length)
 Writes an array of bytes.
 
virtual void WriteInt (int i)
 Writes an int as four bytes.
 
virtual void WriteVInt (int i)
 Writes an int in a variable-length format. Writes between one and five bytes. Smaller values take fewer bytes. Negative numbers are not supported.
 
virtual void WriteLong (long i)
 Writes a long as eight bytes.
 
virtual void WriteVLong (long i)
 Writes an long in a variable-length format. Writes between one and five bytes. Smaller values take fewer bytes. Negative numbers are not supported.
 
virtual void WriteString (System.String s)
 Writes a string.
 
virtual void WriteChars (System.String s, int start, int length)
 Writes a sub sequence of characters from s as the old format (modified UTF-8 encoded bytes).
 
virtual void WriteChars (char[] s, int start, int length)
 Writes a sub sequence of characters from char[] as the old format (modified UTF-8 encoded bytes).
 
virtual void CopyBytes (IndexInput input, long numBytes)
 Copy numBytes bytes from input to ourself.
 
void Close ()
 Closes this stream to further operations.
 
void Dispose ()
 Closes this stream to further operations.
 
virtual void SetLength (long length)
 Set the file length. By default, this method does nothing (it's optional for a Directory to implement it). But, certain Directory implementations (for
 
virtual void WriteStringStringMap (System.Collections.Generic.IDictionary< string, string > map)
 

Protected Member Functions

override void Dispose (bool disposing)
 Closes this stream to further operations.
 

Properties

override long FilePointer [get]
 Returns the current position in this file, where the next write will occur.
 
abstract override long Length [get]
 The number of bytes in the file.
 
- Properties inherited from Lucene.Net.Store.IndexOutput
abstract long FilePointer [get]
 Returns the current position in this file, where the next write will occur.
 
abstract long Length [get]
 The number of bytes in the file.
 

Detailed Description

Base implementation class for buffered IndexOutput.

Definition at line 24 of file BufferedIndexOutput.cs.

Member Function Documentation

override void Lucene.Net.Store.BufferedIndexOutput.Dispose ( bool  disposing)
protectedvirtual

Closes this stream to further operations.

Implements Lucene.Net.Store.IndexOutput.

Reimplemented in Lucene.Net.Store.SimpleFSDirectory.SimpleFSIndexOutput.

Definition at line 131 of file BufferedIndexOutput.cs.

override void Lucene.Net.Store.BufferedIndexOutput.Flush ( )
virtual

Forces any buffered output to be written.

Implements Lucene.Net.Store.IndexOutput.

Definition at line 100 of file BufferedIndexOutput.cs.

abstract void Lucene.Net.Store.BufferedIndexOutput.FlushBuffer ( byte[]  b,
int  offset,
int  len 
)
pure virtual

Expert: implements buffer write. Writes bytes at the current position in the output.

Parameters
bthe bytes to write
offsetthe offset in the byte array
lenthe number of bytes to write

Implemented in Lucene.Net.Store.SimpleFSDirectory.SimpleFSIndexOutput.

override void Lucene.Net.Store.BufferedIndexOutput.Seek ( long  pos)
virtual

Sets current position in this file, where the next write will occur.

See Also
FilePointer

Implements Lucene.Net.Store.IndexOutput.

Reimplemented in Lucene.Net.Store.SimpleFSDirectory.SimpleFSIndexOutput.

Definition at line 156 of file BufferedIndexOutput.cs.

override void Lucene.Net.Store.BufferedIndexOutput.WriteByte ( byte  b)
virtual

Writes a single byte.

See Also
IndexInput.ReadByte()

Implements Lucene.Net.Store.IndexOutput.

Definition at line 37 of file BufferedIndexOutput.cs.

override void Lucene.Net.Store.BufferedIndexOutput.WriteBytes ( byte[]  b,
int  offset,
int  length 
)
virtual

Writes an array of bytes.

Parameters
bthe bytes to write
lengththe number of bytes to write
See Also
IndexInput.ReadBytes(byte[],int,int)

Implements Lucene.Net.Store.IndexOutput.

Definition at line 51 of file BufferedIndexOutput.cs.

Property Documentation

override long Lucene.Net.Store.BufferedIndexOutput.FilePointer
get

Returns the current position in this file, where the next write will occur.

See Also
Seek(long)

Definition at line 149 of file BufferedIndexOutput.cs.

abstract override long Lucene.Net.Store.BufferedIndexOutput.Length
get

The number of bytes in the file.

Definition at line 163 of file BufferedIndexOutput.cs.


The documentation for this class was generated from the following file: