/*
 * 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
 */
public interface VcsCacheableHistorySessionFactory<Cacheable extends Serializable, T extends VcsAbstractHistorySession> {

  T createFromCachedData(@Nullable Cacheable cacheable,
                         @NotNull List<? extends VcsFileRevision> revisions,
                         @NotNull FilePath filePath,
                         @Nullable VcsRevisionNumber currentRevision);

  /**
   * define if path should be changed for session construction (file can be moved)
   */
  @Nullable
  default FilePath getUsedFilePath(T session) {
    return null;
  }

  @Nullable
  default Cacheable getAdditionallyCachedData(T session) {
    return getAddinionallyCachedData(session);
  }

  /**
   * @Deprecated implement getAdditionallyCachedData
   */
  @Deprecated
  @Nullable
  default Cacheable getAddinionallyCachedData(T session) {
    return null;
  }
}

// Copyright 2000-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
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
 */
public interface VcsCacheableHistorySessionFactory<Cacheable extends Serializable, T extends VcsAbstractHistorySession> {

  T createFromCachedData(@Nullable Cacheable cacheable,
                         @NotNull List<? extends VcsFileRevision> revisions,
                         @NotNull FilePath filePath,
                         @Nullable VcsRevisionNumber currentRevision);

  /**
   * define if path should be changed for session construction (file can be moved)
   */
  @Nullable
  default FilePath getUsedFilePath(T session) {
    return null;
  }

  @Nullable
  default Cacheable getAdditionallyCachedData(T session) {
    return getAddinionallyCachedData(session);
  }

  /**
   * @deprecated implement {@link #getAdditionallyCachedData(VcsAbstractHistorySession)}
   */
  @SuppressWarnings("DeprecatedIsStillUsed")
  @Deprecated
  @Nullable
  default Cacheable getAddinionallyCachedData(T session) {
    return null;
  }
}

add deprecation javadoc