com.jetbrains.pluginverifier.repository.cleanup.SweepPolicy.kt Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
 */

package com.jetbrains.pluginverifier.repository.cleanup

import com.jetbrains.pluginverifier.repository.files.AvailableFile
import com.jetbrains.pluginverifier.repository.files.SpaceWeight
import com.jetbrains.pluginverifier.repository.resources.EvictionInfo
import com.jetbrains.pluginverifier.repository.resources.EvictionPolicy
import java.nio.file.Path

/**
 * Sweep policy determines when the cleanup procedure must be carried out
 * and which files should be removed.
 */
interface SweepPolicy : EvictionPolicy {

  override fun isNecessary(totalWeight: SpaceWeight) =
    isNecessary(totalWeight.spaceAmount)

  override fun selectResourcesForEviction(evictionInfo: EvictionInfo) =
    selectFilesForDeletion(SweepInfo(evictionInfo))

  /**
   * Determines whether it is necessary to carry out the cleanup procedure at the moment.
   * This method can be called often, so it is expected to return quickly.
   */
  fun isNecessary(totalSpaceUsed: SpaceAmount): Boolean

  /**
   * Given the current state of the [file repository] [com.jetbrains.pluginverifier.repository.files.FileRepository]
   * determines which files must be removed.
   */
  fun selectFilesForDeletion(sweepInfo: SweepInfo): List>
}