- updated javadoc

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/cli/trunk@267479 13f79535-47bb-0310-9956-ffa450edef68

Author: John Keyes

src/java/org/apache/commons/cli2/validation/ClassValidator.java

@@ -1,5 +1,5 @@
-/**
- * Copyright 2003-2004 The Apache Software Foundation
+/*
+ * Copyright 2003-2005 The Apache Software Foundation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -29,11 +29,24 @@ public class ClassValidator implements Validator {
     private static final ResourceHelper resources =
         ResourceHelper.getResourceHelper(ClassValidator.class);
 
+    /** whether the class argument is loadable */
     private boolean loadable;
+    
+    /** whether to create an instance of the class */
     private boolean instance;
 
+    /** the classloader to load classes from */
     private ClassLoader loader;
 
+    /**
+     * Validate each argument value in the specified List against this instances
+     * permitted attributes.
+     * 
+     * If a value is valid then it's <code>String</code> value in the list is
+     * replaced with it's <code>Class</code> value or instance.
+     * 
+     * @see org.apache.commons.cli2.validation.Validator#validate(java.util.List)
+     */
     public void validate(final List values) throws InvalidArgumentException {
 
         for (final ListIterator i = values.listIterator(); i.hasNext();) {
@@ -80,48 +93,34 @@ public void validate(final List values) throws InvalidArgumentException {
         }
     }
 
-    protected boolean isPotentialClassName(final String name) {
-        final char[] chars = name.toCharArray();
-
-        boolean expectingStart = true;
-
-        for (int i = 0; i < chars.length; ++i) {
-            final char c = chars[i];
-            if (expectingStart) {
-                if (!Character.isJavaIdentifierStart(c)) {
-                    return false;
-                }
-                expectingStart = false;
-            }
-            else {
-                if (c == '.') {
-                    expectingStart = true;
-                }
-                else if (!Character.isJavaIdentifierPart(c)) {
-                    return false;
-                }
-            }
-        }
-        return !expectingStart;
-    }
-
     /**
-     * @return true iff class must be loadable to be valid
+     * Returns whether the argument value must represent a
+     * class that is loadable.
+     *
+     * @return whether the argument value must represent a
+     * class that is loadable.
      */
     public boolean isLoadable() {
         return loadable;
     }
 
     /**
-     * true iff class must be loadable to be valid
-     * @param loadable new loadable value
+     * Specifies whether the argument value must represent a
+     * class that is loadable.
+     *
+     * @param loadable whether the argument value must 
+     * represent a class that is loadable.
      */
     public void setLoadable(boolean loadable) {
         this.loadable = loadable;
     }
 
     /**
-     * @return the classloader to resolve classes in
+     * Returns the {@link ClassLoader} used to resolve and load
+     * the classes specified by the argument values.
+     *
+     * @return the {@link ClassLoader} used to resolve and load
+     * the classes specified by the argument values.
      */
     public ClassLoader getClassLoader() {
         if (loader == null) {
@@ -132,23 +131,65 @@ public ClassLoader getClassLoader() {
     }
 
     /**
-     * @param loader the classloader to resolve classes in
+     * Specifies the {@link ClassLoader} used to resolve and load
+     * the classes specified by the argument values.
+     *
+     * @param loader the {@link ClassLoader} used to resolve and load
+     * the classes specified by the argument values.
      */
     public void setClassLoader(ClassLoader loader) {
         this.loader = loader;
     }
 
     /**
-     * @return true iff class instance is needed to be valid 
+     * Returns whether the argument value must represent a
+     * class that can be instantiated.
+     *
+     * @return whether the argument value must represent a
+     * class that can be instantiated.
      */
     public boolean isInstance() {
         return instance;
     }
 
     /**
-     * @param instance true iff class instance is needed to be valid
+     * Specifies whether the argument value must represent a
+     * class that can be instantiated.
+     *
+     * @param loadable whether the argument value must 
+     * represent a class that can be instantiated.
      */
     public void setInstance(boolean instance) {
         this.instance = instance;
     }
+
+    /**
+     * Returns whether the specified name is allowed as
+     * a Java class name.
+     */
+    protected boolean isPotentialClassName(final String name) {
+        final char[] chars = name.toCharArray();
+
+        boolean expectingStart = true;
+
+        for (int i = 0; i < chars.length; ++i) {
+            final char c = chars[i];
+            if (expectingStart) {
+                if (!Character.isJavaIdentifierStart(c)) {
+                    return false;
+                }
+                expectingStart = false;
+            }
+            else {
+                if (c == '.') {
+                    expectingStart = true;
+                }
+                else if (!Character.isJavaIdentifierPart(c)) {
+                    return false;
+                }
+            }
+        }
+        return !expectingStart;
+    }
+
 }

src/java/org/apache/commons/cli2/validation/EnumValidator.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2003-2004 The Apache Software Foundation
+ * Copyright 2003-2005 The Apache Software Foundation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.