src/Lucene.Net/Codecs/Lucene3x/Lucene3xPostingsFormat.cs

using System;
using System.Runtime.CompilerServices;
using SegmentReadState = Lucene.Net.Index.SegmentReadState;
using SegmentWriteState = Lucene.Net.Index.SegmentWriteState;

namespace Lucene.Net.Codecs.Lucene3x
{
    /*
     * 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.
     */

    /// <summary>
    /// Codec that reads the pre-flex-indexing postings
    /// format.  It does not provide a writer because newly
    /// written segments should use the <see cref="Codec"/> configured on <see cref="Index.IndexWriter"/>.
    /// <para/>
    /// @lucene.experimental
    /// </summary>
    [Obsolete("(4.0) this is only used to read indexes created before 4.0.")]
    [PostingsFormatName("Lucene3x")] // LUCENENET specific - using PostingsFormatName attribute to ensure the default name passed from subclasses is the same as this class name
    internal class Lucene3xPostingsFormat : PostingsFormat
    {
        /// <summary>
        /// Extension of terms file. </summary>
        public const string TERMS_EXTENSION = "tis";

        /// <summary>
        /// Extension of terms index file. </summary>
        public const string TERMS_INDEX_EXTENSION = "tii";

        /// <summary>
        /// Extension of freq postings file. </summary>
        public const string FREQ_EXTENSION = "frq";

        /// <summary>
        /// Extension of prox postings file </summary>
        public const string PROX_EXTENSION = "prx";

        public Lucene3xPostingsFormat()
            : base()
        {
        }

        public override FieldsConsumer FieldsConsumer(SegmentWriteState state)
        {
            throw new NotSupportedException("this codec can only be used for reading");
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public override FieldsProducer FieldsProducer(SegmentReadState state)
        {
            return new Lucene3xFields(state.Directory, state.FieldInfos, state.SegmentInfo, state.Context, state.TermsIndexDivisor);
        }
    }
}