PayloadEncoder.cs

Go to the documentation of this file.

/*
 * 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 Lucene.Net.Index;

namespace Lucene.Net.Analysis.Payloads
{
    /// <summary>
    /// Mainly for use with the DelimitedPayloadTokenFilter, converts char buffers to Payload
    /// <p/>
    /// NOTE: this interface is subject to change
    /// </summary>
    public interface PayloadEncoder
    {
        Payload Encode(char[] buffer);

        /// <summary>
        /// Convert a char array to a <see cref="Payload"/>
        /// </summary>
        /// <returns>An encoded <see cref="Payload"/></returns>
        Payload Encode(char[] buffer, int offset, int length);
    }
}