commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jke...@apache.org
Subject svn commit: r267450 - /jakarta/commons/proper/cli/trunk/src/java/org/apache/commons/cli2/validation/Validator.java
Date Sat, 03 Sep 2005 12:04:13 GMT
Author: jkeyes
Date: Sat Sep  3 05:04:05 2005
New Revision: 267450

URL: http://svn.apache.org/viewcvs?rev=267450&view=rev
Log:
- updated javadoc

Modified:
    jakarta/commons/proper/cli/trunk/src/java/org/apache/commons/cli2/validation/Validator.java

Modified: jakarta/commons/proper/cli/trunk/src/java/org/apache/commons/cli2/validation/Validator.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/cli/trunk/src/java/org/apache/commons/cli2/validation/Validator.java?rev=267450&r1=267449&r2=267450&view=diff
==============================================================================
--- jakarta/commons/proper/cli/trunk/src/java/org/apache/commons/cli2/validation/Validator.java
(original)
+++ jakarta/commons/proper/cli/trunk/src/java/org/apache/commons/cli2/validation/Validator.java
Sat Sep  3 05:04:05 2005
@@ -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.
@@ -18,18 +18,25 @@
 import java.util.List;
 
 /**
- * Identifies (and maybe converts) the acceptable Argument values 
+ * The validation interface for validating argument values(s).
+ *
+ * A validator can replace the argument string value with a
+ * specific class instance e.g. the {@link UrlValidator} replaces
+ * the string value with a {@link java.net.URL} instance.
+ *
+ * @author Rob Oxspring
+ * @author John Keyes
  */
 public interface Validator {
 
     /**
      * Validate the specified values (List of Strings).
      * 
-     * @param values
-     *            the values to validate
+     * @param values The values to validate.
      * 
-     * @throws InvalidArgumentException
-     *             if any of the specified values are not valid
+     * @throws InvalidArgumentException If any of the 
+     * specified values are not valid.
      */
     void validate(final List values) throws InvalidArgumentException;
+
 }



---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message