| using System; |
| |
| namespace Lucene.Net.Codecs |
| { |
| /* |
| * Licensed to the Apache Software Foundation (ASF) under one or more |
| * contributor license agreements. See the NOTICE file distributed with |
| * this work for additional information regarding copyright ownership. |
| * The ASF licenses this file to You under the Apache License, Version 2.0 |
| * (the "License"); you may not use this file except in compliance with |
| * the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| using StoredFieldVisitor = Index.StoredFieldVisitor; |
| |
| /// <summary> |
| /// Codec API for reading stored fields. |
| /// <para/> |
| /// You need to implement <see cref="VisitDocument(int, StoredFieldVisitor)"/> to |
| /// read the stored fields for a document, implement <see cref="Clone()"/> (creating |
| /// clones of any <see cref="Store.IndexInput"/>s used, etc), and <see cref="Dispose(bool)"/> |
| /// to cleanup any allocated resources. |
| /// <para/> |
| /// @lucene.experimental |
| /// </summary> |
| public abstract class StoredFieldsReader : IDisposable |
| #if FEATURE_CLONEABLE |
| , System.ICloneable |
| #endif |
| { |
| /// <summary> |
| /// Sole constructor. (For invocation by subclass |
| /// constructors, typically implicit.) |
| /// </summary> |
| protected internal StoredFieldsReader() |
| { |
| } |
| |
| /// <summary> |
| /// Visit the stored fields for document <paramref name="n"/>. </summary> |
| public abstract void VisitDocument(int n, StoredFieldVisitor visitor); |
| |
| public abstract object Clone(); |
| |
| /// <summary> |
| /// Disposes all resources used by this object. |
| /// </summary> |
| public void Dispose() |
| { |
| Dispose(true); |
| GC.SuppressFinalize(this); |
| } |
| |
| /// <summary> |
| /// Implementations must override and should dispose all resources used by this instance. |
| /// </summary> |
| protected abstract void Dispose(bool disposing); |
| |
| /// <summary> |
| /// Returns approximate RAM bytes used. </summary> |
| public abstract long RamBytesUsed(); |
| |
| /// <summary> |
| /// Checks consistency of this reader. |
| /// <para/> |
| /// Note that this may be costly in terms of I/O, e.g. |
| /// may involve computing a checksum value against large data files. |
| /// <para/> |
| /// @lucene.internal |
| /// </summary> |
| public abstract void CheckIntegrity(); |
| } |
| } |