Add java docs

CJSCommonPlatform · Mar 10, 2017 · fb858d2 · fb858d2
1 parent f7bf76f
commit fb858d2
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/...es-core/src/main/java/uk/gov/justice/services/jdbc/persistence/InitialContextFactory.java b/...es-core/src/main/java/uk/gov/justice/services/jdbc/persistence/InitialContextFactory.java
@@ -3,8 +3,17 @@
 import javax.naming.InitialContext;
 import javax.naming.NamingException;
 
+/**
+ * Simple wrapper class for getting an {@link InitialContext} to allow for mocking in tests
+ */
 public class InitialContextFactory {
 
+    /**
+     * Instantiates a new {@link InitialContext}
+     *
+     * @return a shiny new {@link InitialContext}
+     * @throws NamingException if instantiating the {@link InitialContext} fails
+     */
     public InitialContext create() throws NamingException {
         return new InitialContext();
     }