added javadoc

This commit is contained in:
Sebastian Sdorra
2019-02-19 14:48:38 +01:00
parent ead3062f9c
commit 1f3c811acf

View File

@@ -3,10 +3,29 @@ package sonia.scm.repository.api;
import sonia.scm.plugin.ExtensionPoint; import sonia.scm.plugin.ExtensionPoint;
import sonia.scm.repository.Repository; import sonia.scm.repository.Repository;
/**
* Provider for scm native protocols.
*
* @param <T> type of protocol
*
* @since 2.0.0
*/
@ExtensionPoint(multi = true) @ExtensionPoint(multi = true)
public interface ScmProtocolProvider<T extends ScmProtocol> { public interface ScmProtocolProvider<T extends ScmProtocol> {
/**
* Returns type of repository (e.g.: git, svn, hg, etc.)
*
* @return name of type
*/
String getType(); String getType();
/**
* Returns protocol for the given repository.
*
* @param repository repository
*
* @return protocol for repository
*/
T get(Repository repository); T get(Repository repository);
} }