Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class RevisionFile

    Describes a file in a IRevision. A file has a source, which allows a single revision to contain files from multiple sources (e.g. multiple indexes).

    Inheritance
    object
    RevisionFile
    Implements
    IEquatable<RevisionFile>
    Inherited Members
    object.Equals(object, object)
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Lucene.Net.Replicator
    Assembly: Lucene.Net.Replicator.dll
    Syntax
    public class RevisionFile : IEquatable<RevisionFile>
    Remarks

    Note

    This API is experimental and might change in incompatible ways in the next release.

    Constructors

    RevisionFile(string, long)

    Constructor with the given file name and optionally length.

    Declaration
    public RevisionFile(string fileName, long length = -1)
    Parameters
    Type Name Description
    string fileName

    The name of the file

    long length

    Optional, the length of the file.

    Remarks

    Note

    This API is experimental and might change in incompatible ways in the next release.

    Properties

    FileName

    Gets the name of the file.

    Declaration
    public string FileName { get; }
    Property Value
    Type Description
    string
    Remarks

    Note

    This API is experimental and might change in incompatible ways in the next release.

    Length

    Gets or sets the length of the file denoted by FileName.

    Declaration
    public long Length { get; set; }
    Property Value
    Type Description
    long
    Remarks

    Note

    This API is experimental and might change in incompatible ways in the next release.

    Methods

    Equals(RevisionFile)

    Indicates whether the current object is equal to another object of the same type.

    Declaration
    public virtual bool Equals(RevisionFile other)
    Parameters
    Type Name Description
    RevisionFile other

    An object to compare with this object.

    Returns
    Type Description
    bool

    true if the current object is equal to the other parameter; otherwise, false.

    Remarks

    Note

    This API is experimental and might change in incompatible ways in the next release.

    Equals(object)

    Determines whether the specified object is equal to the current object.

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    object obj

    The object to compare with the current object.

    Returns
    Type Description
    bool

    true if the specified object is equal to the current object; otherwise, false.

    Overrides
    object.Equals(object)
    Remarks

    Note

    This API is experimental and might change in incompatible ways in the next release.

    GetHashCode()

    Serves as the default hash function.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    int

    A hash code for the current object.

    Overrides
    object.GetHashCode()
    Remarks

    Note

    This API is experimental and might change in incompatible ways in the next release.

    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()
    Remarks

    Note

    This API is experimental and might change in incompatible ways in the next release.

    Implements

    IEquatable<T>
    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.