IndexCommit.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 System;
using System.Collections.Generic;
using Lucene.Net.Store;
using Directory = Lucene.Net.Store.Directory;

namespace Lucene.Net.Index
{
    
    
    public abstract class IndexCommit
    {
        public abstract string SegmentsFileName { get; }

        public abstract ICollection<string> FileNames { get; }

        public abstract Directory Directory { get; }

        public abstract void Delete();

        public abstract bool IsDeleted { get; }

        public abstract bool IsOptimized { get; }

        public  override bool Equals(System.Object other)
        {
            if (other is IndexCommit)
            {
                IndexCommit otherCommit = (IndexCommit) other;
                return otherCommit.Directory.Equals(Directory) && otherCommit.Version == Version;
            }
            else
                return false;
        }
        
        public override int GetHashCode()
        {
            return (int)(Directory.GetHashCode() + Version);
        }

        public abstract long Version { get; }

        public abstract long Generation { get; }

        public virtual long Timestamp
        {
            get { return Directory.FileModified(SegmentsFileName); }
        }

        public abstract IDictionary<string, string> UserData { get; }
    }
}