platform/vcs-api/src/com/intellij/openapi/vcs/history/VcsCacheableHistorySessionFactory.java

/*
 * Copyright 2000-2011 JetBrains s.r.o.
 *
 * Licensed 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.
 */
package com.intellij.openapi.vcs.history;

import com.intellij.openapi.vcs.FilePath;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.io.Serializable;
import java.util.List;

/**
 * @author irengrig
 *         Date: 3/15/11
 *         Time: 1:32 PM
 */
public interface VcsCacheableHistorySessionFactory<Cacheable extends Serializable, T extends VcsAbstractHistorySession> {
  /**
   * define if path should be changed for session construction (file can be moved)
   */
  @Nullable
  FilePath getUsedFilePath(final T session);
  @Nullable
  Cacheable getAddinionallyCachedData(final T session);
  T createFromCachedData(@Nullable final Cacheable cacheable,
                         @NotNull final List<VcsFileRevision> revisions,
                         @NotNull final FilePath filePath,
                         @Nullable final VcsRevisionNumber currentRevision);
}