From 49e9671fa7df758e2c34eccbf60b2e1b6e1c94fd Mon Sep 17 00:00:00 2001 From: Sebastian Sdorra Date: Wed, 13 Feb 2019 12:42:07 +0100 Subject: [PATCH] added some javadoc --- .../main/java/sonia/scm/repository/HgContextProvider.java | 3 +++ .../java/sonia/scm/repository/HgContextRequestStore.java | 5 ++++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/HgContextProvider.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/HgContextProvider.java index e6f7436650..89170713ac 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/HgContextProvider.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/HgContextProvider.java @@ -42,6 +42,9 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** + * Injection provider for {@link HgContext}. + * This provider returns an instance {@link HgContext} from request scope, if no {@link HgContext} could be found in + * request scope (mostly because the scope is not available) a new {@link HgContext} gets returned. * * @author Sebastian Sdorra */ diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/HgContextRequestStore.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/HgContextRequestStore.java index 156e915416..6043c347ff 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/HgContextRequestStore.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/HgContextRequestStore.java @@ -2,10 +2,13 @@ package sonia.scm.repository; import com.google.inject.servlet.RequestScoped; +/** + * Holds an instance of {@link HgContext} in the request scope. + */ @RequestScoped public class HgContextRequestStore { - private HgContext context = new HgContext(); + private final HgContext context = new HgContext(); public HgContext get() { return context;