IndexableFilesProvider: add getDebugName()

GitOrigin-RevId: 75bca53859d1a705786816b0dcf2812a87ca1afc
This commit is contained in:
Sergey Patrikeev
2020-03-22 17:32:29 +00:00
committed by intellij-monorepo-bot
parent 5f4c990aca
commit 73f29b64e0
5 changed files with 12 additions and 0 deletions
@@ -16,6 +16,11 @@ import org.jetbrains.annotations.ApiStatus;
@ApiStatus.Internal
public interface IndexableFilesProvider {
/**
* Presentable name that can be shown in logs and used for debugging purposes.
*/
String getDebugName();
/**
* Presentable text shown in progress indicator during indexing of files of this provider.
*/
@@ -10,6 +10,7 @@ import com.intellij.util.indexing.IndexableSetContributor
import com.intellij.util.indexing.IndexingBundle
internal class IndexableSetContributorFilesProvider(private val indexableSetContributor: IndexableSetContributor) : IndexableFilesProvider {
override fun getDebugName() = getName() ?: indexableSetContributor.toString()
override fun getIndexingProgressText(): String {
val name = getName()
@@ -10,6 +10,8 @@ import com.intellij.util.containers.ConcurrentBitSet
import com.intellij.util.indexing.IndexingBundle
internal class LibraryIndexableFilesProvider(val library: Library) : IndexableFilesProvider {
override fun getDebugName() = library.name.takeUnless { it.isNullOrEmpty() } ?: library.toString()
override fun getIndexingProgressText(): String? {
val libraryName = library.name
if (!libraryName.isNullOrEmpty()) {
@@ -11,6 +11,8 @@ import com.intellij.util.containers.ConcurrentBitSet
import com.intellij.util.indexing.IndexingBundle
internal class ModuleIndexableFilesProvider(val module: Module) : IndexableFilesProvider {
override fun getDebugName() = module.name
override fun getIndexingProgressText() = IndexingBundle.message("indexable.files.provider.indexing.module.name", module.name)
override fun getRootsScanningProgressText() = IndexingBundle.message("indexable.files.provider.scanning.module.name", module.name)
@@ -12,6 +12,8 @@ import org.jetbrains.annotations.ApiStatus
@ApiStatus.Internal
class SdkIndexableFilesProvider(val sdk: Sdk) : IndexableFilesProvider {
override fun getDebugName() = sdk.name
override fun getIndexingProgressText() = IndexingBundle.message("indexable.files.provider.indexing.sdk.name", sdk.name)
override fun getRootsScanningProgressText() = IndexingBundle.message("indexable.files.provider.scanning.sdk.name", sdk.name)