com.jetbrains.pluginverifier.plugin.PluginFileProvider.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.plugin

import com.jetbrains.pluginverifier.repository.PluginInfo
import com.jetbrains.pluginverifier.repository.files.FileLock

/**
 * Provides files of [PluginInfo] locked with [FileLock]s.
 */
interface PluginFileProvider {

  /**
   * Finds a file of the [pluginInfo] and wraps
   * it with [FileLock] if necessary.
   */
  fun getPluginFile(pluginInfo: PluginInfo): Result

  /**
   * Represents possible outcomes of [fetching] [getPluginFile] the plugin's file.
   */
  sealed class Result {

    data class Found(val pluginFileLock: FileLock) : Result()

    data class NotFound(val reason: String) : Result()

    data class Failed(val reason: String, val error: Exception) : Result()
  }

}