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.RAMOutputStream Class Reference

A memory-resident IndexOutput implementation. More...

Inherits Lucene.Net.Store.IndexOutput.

Public Member Functions

 RAMOutputStream ()
 Construct an empty output buffer.
 
virtual void WriteTo (IndexOutput out_Renamed)
 Copy the current contents of this buffer to the named output.
 
virtual void Reset ()
 Resets this to an empty buffer.
 
override void Seek (long pos)
 Sets current position in this file, where the next write will occur.
 
override void WriteByte (byte b)
 Writes a single byte.
 
override void WriteBytes (byte[] b, int offset, int len)
 Writes an array of bytes.
 
override void Flush ()
 Forces any buffered output to be written.
 
virtual long SizeInBytes ()
 Returns byte usage of all buffers.
 
- 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

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

A memory-resident IndexOutput implementation.

For lucene internal use.

Definition at line 26 of file RAMOutputStream.cs.

Constructor & Destructor Documentation

Lucene.Net.Store.RAMOutputStream.RAMOutputStream ( )

Construct an empty output buffer.

Definition at line 42 of file RAMOutputStream.cs.

Member Function Documentation

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

Implements Lucene.Net.Store.IndexOutput.

Definition at line 89 of file RAMOutputStream.cs.

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

Forces any buffered output to be written.

Implements Lucene.Net.Store.IndexOutput.

Definition at line 174 of file RAMOutputStream.cs.

virtual void Lucene.Net.Store.RAMOutputStream.Reset ( )
virtual

Resets this to an empty buffer.

Definition at line 78 of file RAMOutputStream.cs.

override void Lucene.Net.Store.RAMOutputStream.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 101 of file RAMOutputStream.cs.

virtual long Lucene.Net.Store.RAMOutputStream.SizeInBytes ( )
virtual

Returns byte usage of all buffers.

Definition at line 186 of file RAMOutputStream.cs.

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

Writes a single byte.

See Also
IndexInput.ReadByte()

Implements Lucene.Net.Store.IndexOutput.

Definition at line 120 of file RAMOutputStream.cs.

override void Lucene.Net.Store.RAMOutputStream.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 130 of file RAMOutputStream.cs.

virtual void Lucene.Net.Store.RAMOutputStream.WriteTo ( IndexOutput  out_Renamed)
virtual

Copy the current contents of this buffer to the named output.

Definition at line 57 of file RAMOutputStream.cs.

Property Documentation

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

Definition at line 181 of file RAMOutputStream.cs.

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

Definition at line 116 of file RAMOutputStream.cs.


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