added missing javadoc

This commit is contained in:
Sebastian Sdorra
2020-03-26 11:34:28 +01:00
parent 2438e980a7
commit 3ffece1547

View File

@@ -27,6 +27,19 @@ package sonia.scm.web.api;
import de.otto.edison.hal.HalRepresentation;
import sonia.scm.repository.Repository;
/**
* Maps a repository to a hal representation.
* This is especially useful if a plugin would deliver a repository to the frontend.
*
* @since 2.0.0
*/
public interface RepositoryToHalMapper {
/**
* Returns the hal representation of the repository.
*
* @param repository repository to map
* @return hal representation
*/
HalRepresentation map(Repository repository);
}