- updated javadoc

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

Author: John Keyes

src/java/org/apache/commons/cli2/validation/DateValidator.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.
@@ -22,8 +22,36 @@
 import java.util.ListIterator;
 
 /**
- * @author John Keyes
+ * A Validator for date and time value(s).
+ *
+ * The following example shows how to validate that
+ * an argument value(s) is a Date of the following 
+ * type: d/M/yy (see {@link java.text.DateFormat}).
+ *
+ * <pre>
+ * DateFormat date = new SimpleDateFormat("d/M/yy");
+ * ...
+ * ArgumentBuilder builder = new ArgumentBuilder();
+ * Argument dateFormat = 
+ *     builder.withName("date");
+ *            .withValidator(new DateValidator(dateFormat));
+ * </pre>
+ *
+ * The following example shows how to validate that
+ * an argument value(s) is a time of the following 
+ * type: HH:mm:ss (see {@link java.text.DateFormat}).
+ *
+ * <pre>
+ * DateFormat timeFormat = new SimpleDateFormat("HH:mm:ss");
+ * ...
+ * ArgumentBuilder builder = new ArgumentBuilder();
+ * Argument time = 
+ *     builder.withName("time");
+ *            .withValidator(new DateValidator(timeFormat));
+ * </pre>
  * 
+ * @author John Keyes
+ *
  * @see java.text.DateFormat
  */
 public class DateValidator implements Validator {

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

@@ -99,13 +99,17 @@ private String getValuesAsString() {
     }
 
     /**
+     * Returns the Set of valid argument values.
+     *
      * @return Returns the Set of valid argument values.
      */
     public Set getValidValues() {
         return validValues;
     }
 
     /**
+     * Specifies the Set of valid argument values.
+     *
      * @param validValues The Set of valid argument values.
      */
     public void setValidValues(Set validValues) {