diff --git a/platform/dvcs-api/src/com/intellij/dvcs/hosting/RepositoryHostingService.java b/platform/dvcs-api/src/com/intellij/dvcs/hosting/RepositoryHostingService.java index b3dda34179d2..0a9db9ec24a8 100644 --- a/platform/dvcs-api/src/com/intellij/dvcs/hosting/RepositoryHostingService.java +++ b/platform/dvcs-api/src/com/intellij/dvcs/hosting/RepositoryHostingService.java @@ -5,10 +5,19 @@ import com.intellij.openapi.project.Project; import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; +/** + * Represents a remote service that hosts VCS repositories, e.g GitHub, BitBucket + */ public interface RepositoryHostingService { + /** + * @return service name that will be used in UI actions + */ @NotNull String getServiceDisplayName(); + /** + * @see RepositoryListLoader + */ @Nullable default RepositoryListLoader getRepositoryListLoader(@NotNull Project project) {return null;} } diff --git a/platform/dvcs-api/src/com/intellij/dvcs/hosting/RepositoryListLoader.java b/platform/dvcs-api/src/com/intellij/dvcs/hosting/RepositoryListLoader.java index 846c6afce876..4dc8c8e46782 100644 --- a/platform/dvcs-api/src/com/intellij/dvcs/hosting/RepositoryListLoader.java +++ b/platform/dvcs-api/src/com/intellij/dvcs/hosting/RepositoryListLoader.java @@ -9,9 +9,19 @@ import org.jetbrains.annotations.NotNull; import java.util.List; +/** + * Allows to query remote service for a list of available VCS repositories with the current IDEA settings. + * Can be used to suggest the list of repositories that can be checked out. + */ public interface RepositoryListLoader { + /** + * Check if this loader is configured (e.g. has necessary authentication data) + */ boolean isEnabled(); + /** + * Prompt user for additional configuration (e.g. provide credentials) + */ boolean enable(); @CalledInBackground