MONDRIAN

   Better example of a test case in documentation.

[git-p4: depot-paths = "//open/mondrian/": change = 8669]

src/main/mondrian/util/ObjectFactory.java

@@ -178,26 +178,42 @@
  *          boolean getValue();
  *          .......
  *      }
+ *      class MyCode {
+ *          private Boo boo;
+ *          MyCode() {
+ *              boo = BooFactory.instance().getObject();
+ *          }
+ *          .......
+ *          int getValue() {
+ *              if (boo.getValue()) {
+ *                  return 1;
+ *              } else {
+ *                  return 0;
+ *              }
+ *              
+ *          }
+ *      }
  * 
- *      class MyTest {
+ *      class MyCodeTest {
  *          private static boolean testValue;
  *          static class BooTest implements Boo {
  *              public boolean getValue() {
  *                  return MyTest.testValue;
  *              }
  *          }
  *          public void test() {
- *              BooFactory bf = BooFactory.instance();
  *              try {
  *                  BooFactory.setThreadLocalClassName("MyTest.BooTest");
- * 
+ *
  *                  MyTest.testValue = true;
- *                  Boo boo1 = bf.getObject();
- *                  assertTrue("Value not true", boo1.getValue());
+ *                  MyCode myCode = new MyCode();
+ *                  int value = myCode.getValue();
+ *                  assertTrue("Value not 1", (value == 1));
  * 
  *                  MyTest.testValue = false;
- *                  Boo boo2 = bf.getObject();
- *                  assertTrue("Value is true", ! boo2.getValue());
+ *                  myCode = new MyCode();
+ *                  value = myCode.getValue();
+ *                  assertTrue("Value not 0", (value == 0));
  *              } finally {
  *                  BooFactory.clearThreadLocalClassName();
  *              }
@@ -207,7 +223,10 @@
  * </pre>
  * <p>
  * While this is a very simple example, it shows how using such factories
- * can aid in creating testable code.
+ * can aid in creating testable code. The MyCode method is a client of
+ * the Boo implementation. How to test the two different code branches the
+ * method can take? Because the Boo object is generated by a factory,
+ * one can override what object the factory returns.
  *
  * @author <a>Richard M. Emberson</a>
  * @since Feb 01 2007