Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class MockIndexOutputWrapper

    Used by MockDirectoryWrapper to create an output stream that will throw an IOException on fake disk full, track max disk space actually used, and maybe throw random IOExceptions.

    Inheritance
    object
    DataOutput
    IndexOutput
    MockIndexOutputWrapper
    Implements
    IDisposable
    Inherited Members
    IndexOutput.Dispose()
    DataOutput.WriteBytes(byte[], int)
    DataOutput.WriteInt32(int)
    DataOutput.WriteInt16(short)
    DataOutput.WriteVInt32(int)
    DataOutput.WriteInt64(long)
    DataOutput.WriteVInt64(long)
    DataOutput.WriteString(string)
    DataOutput.WriteStringStringMap(IDictionary<string, string>)
    DataOutput.WriteStringSet(ISet<string>)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Lucene.Net.Store
    Assembly: Lucene.Net.TestFramework.dll
    Syntax
    public class MockIndexOutputWrapper : IndexOutput, IDisposable

    Constructors

    MockIndexOutputWrapper(MockDirectoryWrapper, IndexOutput, string)

    Construct an empty output buffer.

    Declaration
    public MockIndexOutputWrapper(MockDirectoryWrapper dir, IndexOutput @delegate, string name)
    Parameters
    Type Name Description
    MockDirectoryWrapper dir
    IndexOutput delegate
    string name

    Properties

    Checksum

    Returns the current checksum of bytes written so far

    Declaration
    public override long Checksum { get; }
    Property Value
    Type Description
    long
    Overrides
    Lucene.Net.Store.IndexOutput.Checksum

    Length

    Gets or Sets the file length. By default, this property's setter does nothing (it's optional for a Lucene.Net.Store.Directory to implement it). But, certain Lucene.Net.Store.Directory implementations (for example Lucene.Net.Store.FSDirectory) can use this to inform the underlying IO system to pre-allocate the file to the specified size. If the length is longer than the current file length, the bytes added to the file are undefined. Otherwise the file is truncated.

    Declaration
    public override long Length { get; set; }
    Property Value
    Type Description
    long
    Overrides
    Lucene.Net.Store.IndexOutput.Length

    Position

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

    This was getFilePointer() in Lucene.
    Declaration
    public override long Position { get; }
    Property Value
    Type Description
    long
    Overrides
    Lucene.Net.Store.IndexOutput.Position
    See Also
    Seek(long)

    Methods

    CopyBytes(DataInput, long)

    Copy numBytes bytes from input to ourself.

    Declaration
    public override void CopyBytes(DataInput input, long numBytes)
    Parameters
    Type Name Description
    DataInput input
    long numBytes
    Overrides
    DataOutput.CopyBytes(DataInput, long)

    Dispose(bool)

    Closes this stream to further operations.

    Declaration
    protected override void Dispose(bool disposing)
    Parameters
    Type Name Description
    bool disposing
    Overrides
    IndexOutput.Dispose(bool)

    Flush()

    Forces any buffered output to be written.

    Declaration
    public override void Flush()
    Overrides
    Lucene.Net.Store.IndexOutput.Flush()

    Seek(long)

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

    Declaration
    [Obsolete("(4.1) this method will be removed in Lucene 5.0")]
    public override void Seek(long pos)
    Parameters
    Type Name Description
    long pos
    Overrides
    IndexOutput.Seek(long)
    See Also
    Position

    ToString()

    Returns a string that represents the current object.

    Declaration
    public override string ToString()
    Returns
    Type Description
    string

    A string that represents the current object.

    Overrides
    object.ToString()

    WriteByte(byte)

    Writes a single byte.

    The most primitive data type is an eight-bit byte. Files are accessed as sequences of bytes. All other data types are defined as sequences of bytes, so file formats are byte-order independent.
    Declaration
    public override void WriteByte(byte b)
    Parameters
    Type Name Description
    byte b
    Overrides
    DataOutput.WriteByte(byte)
    See Also
    ReadByte()

    WriteBytes(byte[], int, int)

    Writes an array of bytes.

    Declaration
    public override void WriteBytes(byte[] b, int offset, int len)
    Parameters
    Type Name Description
    byte[] b

    the bytes to write

    int offset

    the offset in the byte array

    int len
    Overrides
    DataOutput.WriteBytes(byte[], int, int)
    See Also
    ReadBytes(byte[], int, int)

    Implements

    IDisposable
    Back to top Copyright © 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
    Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
    All other marks mentioned may be trademarks or registered trademarks of their respective owners.