Add setting docs; deprecate RuleChainWalker (#92)

Author: sbabcoc

src/main/java/com/nordstrom/automation/junit/JUnitConfig.java

@@ -24,13 +24,28 @@ public class JUnitConfig extends SettingsCore<JUnitConfig.JUnitSettings> {
      * the {@code junit.properties} file and System property declarations.
      */
     public enum JUnitSettings implements SettingsCore.SettingsAPI {
-        /** name: <b>junit.rule.chain.list</b> <br> default: {@code rulesStartingWithInnerMost} */
-        RULE_CHAIN_LIST("junit.rule.chain.list", "rulesStartingWithInnerMost"),
-        /** name: <b>junit.timeout.test</b> <br> default: {@code null} */
+        /**
+         * Global per-test timeout interval in milliseconds.
+         * <p>
+         * name: <b>junit.timeout.test</b><br>
+         * default: {@code null}
+         */
         TEST_TIMEOUT("junit.timeout.test", null),
-        /** name: <b>junit.timeout.rule</b> <br> default: {@code null} */
+        
+        /**
+         * Global per-class timeout interval in milliseconds.
+         * <p>
+         * name: <b>junit.timeout.rule</b><br>
+         * default: {@code null}
+         */
         TIMEOUT_RULE("junit.timeout.rule", null),
-        /** name: <b>junit.max.retry</b> <br> default: <b>0</b> */
+        
+        /**
+         * Maximum retry attempts for failed test methods.
+         * <p>
+         * name: <b>junit.max.retry</b><br>
+         * default: <b>0</b>
+         */
         MAX_RETRY("junit.max.retry", "0");
 
         private String propertyName;

src/main/java/com/nordstrom/automation/junit/RuleChainWalker.java

@@ -7,13 +7,16 @@
 import org.junit.rules.TestRule;
 
 import com.google.common.base.Optional;
-import com.nordstrom.automation.junit.JUnitConfig.JUnitSettings;
 import com.nordstrom.common.base.UncheckedThrow;
 
 /**
  * This is a static utility class that uses reflection to access the list of {@link TestRule} objects inside a
  * {@link RuleChain}.
+ * 
+ * @deprecated Use the <a href='https://junit.org/junit4/javadoc/4.13.1/org/junit/Rule.html#order()'>order</a>
+ *             parameter of the {@literal @}Rule annotation instead of {@link RuleChain}.
  */
+@Deprecated
 public class RuleChainWalker {
 
     private RuleChainWalker() {
@@ -48,8 +51,7 @@ public static <T extends TestRule> Optional<T> getAttachedRule(RuleChain ruleCha
     private static List<TestRule> getRuleList(RuleChain ruleChain) {
         Field ruleChainList;
         try {
-            String fieldName = JUnitConfig.getConfig().getString(JUnitSettings.RULE_CHAIN_LIST.key());
-            ruleChainList = RuleChain.class.getDeclaredField(fieldName);
+            ruleChainList = RuleChain.class.getDeclaredField("rulesStartingWithInnerMost");
             ruleChainList.setAccessible(true);
             return (List<TestRule>) ruleChainList.get(ruleChain);
         } catch (NoSuchFieldException | SecurityException | IllegalArgumentException | IllegalAccessException e) {