src/Lucene.Net/Analysis/TokenAttributes/OffsetAttribute.cs

using System;

namespace Lucene.Net.Analysis.TokenAttributes
{
    /*
     * 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 Attribute = Lucene.Net.Util.Attribute;
    using IAttribute = Lucene.Net.Util.IAttribute;

    /// <summary>
    /// Default implementation of <see cref="IOffsetAttribute"/>. </summary>
    public class OffsetAttribute : Attribute, IOffsetAttribute
#if FEATURE_CLONEABLE
        , System.ICloneable
#endif
    {
        private int startOffset;
        private int endOffset;

        /// <summary>
        /// Initialize this attribute with startOffset and endOffset of 0. </summary>
        public OffsetAttribute()
        {
        }

        public virtual int StartOffset => startOffset;

        public virtual void SetOffset(int startOffset, int endOffset)
        {
            // TODO: we could assert that this is set-once, ie,
            // current values are -1?  Very few token filters should
            // change offsets once set by the tokenizer... and
            // tokenizer should call clearAtts before re-using
            // OffsetAtt

            if (startOffset < 0 || endOffset < startOffset)
            {
                throw new ArgumentException("startOffset must be non-negative, and endOffset must be >= startOffset, " + "startOffset=" + startOffset + ",endOffset=" + endOffset);
            }

            this.startOffset = startOffset;
            this.endOffset = endOffset;
        }

        public virtual int EndOffset => endOffset;

        public override void Clear()
        {
            // TODO: we could use -1 as default here?  Then we can
            // assert in setOffset...
            startOffset = 0;
            endOffset = 0;
        }

        public override bool Equals(object other)
        {
            if (other == this)
            {
                return true;
            }

            if (other is OffsetAttribute o)
            {
                return o.startOffset == startOffset && o.endOffset == endOffset;
            }

            return false;
        }

        public override int GetHashCode()
        {
            int code = startOffset;
            code = code * 31 + endOffset;
            return code;
        }

        public override void CopyTo(IAttribute target)
        {
            OffsetAttribute t = (OffsetAttribute)target;
            t.SetOffset(startOffset, endOffset);
        }
    }
}