Lucene.Net  3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
Public Member Functions | Protected Member Functions | Properties | List of all members
Lucene.Net.Store.ChecksumIndexOutput Class Reference

Writes bytes through to a primary IndexOutput, computing checksum. Note that you cannot use seek(). More...

Inherits Lucene.Net.Store.IndexOutput.

Public Member Functions

 ChecksumIndexOutput (IndexOutput main)
 
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.
 
override void Seek (long pos)
 Sets current position in this file, where the next write will occur.
 
virtual void PrepareCommit ()
 Starts but does not complete the commit of this file (= writing of the final checksum at the end). After this is called must call FinishCommit and the Dispose to complete the commit.
 
virtual void FinishCommit ()
 See PrepareCommit
 
- 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)
 

Properties

virtual long Checksum [get]
 
override long FilePointer [get]
 
override long Length [get]
 
- 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

Writes bytes through to a primary IndexOutput, computing checksum. Note that you cannot use seek().

Definition at line 28 of file CheckSumIndexOutput.cs.

Constructor & Destructor Documentation

Lucene.Net.Store.ChecksumIndexOutput.ChecksumIndexOutput ( IndexOutput  main)

Definition at line 35 of file CheckSumIndexOutput.cs.

Member Function Documentation

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

Implements Lucene.Net.Store.IndexOutput.

Definition at line 63 of file CheckSumIndexOutput.cs.

virtual void Lucene.Net.Store.ChecksumIndexOutput.FinishCommit ( )
virtual

See PrepareCommit

Definition at line 105 of file CheckSumIndexOutput.cs.

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

Forces any buffered output to be written.

Implements Lucene.Net.Store.IndexOutput.

Definition at line 58 of file CheckSumIndexOutput.cs.

virtual void Lucene.Net.Store.ChecksumIndexOutput.PrepareCommit ( )
virtual

Starts but does not complete the commit of this file (= writing of the final checksum at the end). After this is called must call FinishCommit and the Dispose to complete the commit.

Definition at line 90 of file CheckSumIndexOutput.cs.

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

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

See Also
FilePointer()

Implements Lucene.Net.Store.IndexOutput.

Definition at line 80 of file CheckSumIndexOutput.cs.

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

Writes a single byte.

See Also
IndexInput.ReadByte()

Implements Lucene.Net.Store.IndexOutput.

Definition at line 41 of file CheckSumIndexOutput.cs.

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

Writes an array of bytes.

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

Implements Lucene.Net.Store.IndexOutput.

Definition at line 47 of file CheckSumIndexOutput.cs.

Property Documentation

virtual long Lucene.Net.Store.ChecksumIndexOutput.Checksum
get

Definition at line 54 of file CheckSumIndexOutput.cs.

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

Definition at line 76 of file CheckSumIndexOutput.cs.

override long Lucene.Net.Store.ChecksumIndexOutput.Length
get

Definition at line 111 of file CheckSumIndexOutput.cs.


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