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 23d3cf6eec265f0f15b497673fd12a6d00e526e3..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
@@ -1,11 +1,23 @@
+/*
+ * Copyright 2005-2010 the original author or authors.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */ 
 package org.wamblee.support.jndi;
 
-import java.util.HashMap;
 import java.util.Hashtable;
-import java.util.Map;
 
 import javax.naming.Context;
-import javax.naming.InitialContext;
 import javax.naming.NamingException;
 import javax.naming.spi.InitialContextFactory;
 
@@ -15,19 +27,25 @@ 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 {
 
-    private static Context context;
+    private static Context CONTEXT;
 
     private static void initialize() {
         try {
-            context = new StubInitialContext();
+            CONTEXT = new StubInitialContext();
         } catch (NamingException e) { // can't happen.
             throw new RuntimeException(e);
         }
@@ -43,7 +61,7 @@ public class StubInitialContextFactory implements InitialContextFactory {
         // sets up the InitialContextFactoryForTest as default factory.
         System.setProperty(Context.INITIAL_CONTEXT_FACTORY,
             StubInitialContextFactory.class.getName());
-        if (context == null) {
+        if (CONTEXT == null) {
             initialize();
         }
     }
@@ -53,11 +71,11 @@ public class StubInitialContextFactory implements InitialContextFactory {
      */
     public static void unregister() {
         System.setProperty(Context.INITIAL_CONTEXT_FACTORY, "");
-        context = null;
+        CONTEXT = null;
     }
 
-    public Context getInitialContext(Hashtable<?, ?> environment)
+    public Context getInitialContext(Hashtable<?, ?> aEnvironment)
         throws NamingException {
-        return context;
+        return CONTEXT;
     }
 }