diff --git a/scm-core/src/main/java/sonia/scm/web/api/RepositoryToHalMapper.java b/scm-core/src/main/java/sonia/scm/web/api/RepositoryToHalMapper.java index 90ca664cee..b5184fb202 100644 --- a/scm-core/src/main/java/sonia/scm/web/api/RepositoryToHalMapper.java +++ b/scm-core/src/main/java/sonia/scm/web/api/RepositoryToHalMapper.java @@ -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); }