More javadoc.

[utils] / test / enterprise / src / main / java / org / wamblee / support / jndi / StubInitialContextFactory.java

diff --git a/test/enterprise/src/main/java/org/wamblee/support/jndi/StubInitialContextFactory.java b/test/enterprise/src/main/java/org/wamblee/support/jndi/StubInitialContextFactory.java
index d65968a21e5e22e00aad4e5999fb06522d97ac88..158bd6d8b8d8048ff8928e6c844681c0e6fac262 100644 (file)
--- a/test/enterprise/src/main/java/org/wamblee/support/jndi/StubInitialContextFactory.java
+++ b/test/enterprise/src/main/java/org/wamblee/support/jndi/StubInitialContextFactory.java
@@ -27,11 +27,17 @@ import javax.naming.spi.InitialContextFactory;
  * 
  * See {@link #bind(String, Object)} to resp. register the initial context.
  * 
- * To bind objects in the JNDI tree simply use the standard JNDI api: <code>
+ * To start mocking the JNDI tree, call {@link #register()}. 
+ * 
+ * To bind objects in the JNDI tree simply use the standard JNDI api: 
+ * <pre>
  *   InitialContext context = new InitialContext();
  *   MyClass myObj = ...; 
  *   context.bind("a/b", myObj); 
- * </code>
+ * </pre>
+ * 
+ * When finished with a test case, call {@link #unregister()} to unregister the 
+ * JNDI tree again. 
  */
 public class StubInitialContextFactory implements InitialContextFactory {