commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jke...@apache.org
Subject cvs commit: jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/validation EnumValidator.java StringValidator.java
Date Wed, 22 Oct 2003 15:53:17 GMT
jkeyes      2003/10/22 08:53:17

  Modified:    cli/src/test/org/apache/commons/cli2/apps LsTest.java
  Added:       cli/src/java/org/apache/commons/cli2/validation
                        EnumValidator.java
  Removed:     cli/src/java/org/apache/commons/cli2/validation
                        StringValidator.java
  Log:
  - renamed StringValidator to EnumValidator
  
  Revision  Changes    Path
  1.3       +5 -5      jakarta-commons-sandbox/cli/src/test/org/apache/commons/cli2/apps/LsTest.java
  
  Index: LsTest.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons-sandbox/cli/src/test/org/apache/commons/cli2/apps/LsTest.java,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- LsTest.java	21 Oct 2003 15:39:46 -0000	1.2
  +++ LsTest.java	22 Oct 2003 15:53:17 -0000	1.3
  @@ -75,7 +75,7 @@
   import org.apache.commons.cli2.GroupBuilder;
   import org.apache.commons.cli2.Option;
   import org.apache.commons.cli2.OptionException;
  -import org.apache.commons.cli2.validation.StringValidator;
  +import org.apache.commons.cli2.validation.EnumValidator;
   
   /**
    * <p>
  @@ -321,7 +321,7 @@
                           .withMaximum(1)
                           .withMinimum(1)
                           .withInitialSeparator('=')
  -                        .withValidator(new StringValidator(colors))
  +                        .withValidator(new EnumValidator(colors))
                           .create())
                   .create();
                   
  
  
  
  1.1                  jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/validation/EnumValidator.java
  
  Index: EnumValidator.java
  ===================================================================
  /*
   * $Header: /home/cvs/jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/validation/EnumValidator.java,v
1.1 2003/10/22 15:53:17 jkeyes Exp $
   * $Revision: 1.1 $
   * $Date: 2003/10/22 15:53:17 $
   *
   * ====================================================================
   *
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 2003 The Apache Software Foundation.  All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution, if
   *    any, must include the following acknowlegement:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowlegement may appear in the software itself,
   *    if and wherever such third-party acknowlegements normally appear.
   *
   * 4. The names "The Jakarta Project", "Commons", and "Apache Software
   *    Foundation" must not be used to endorse or promote products derived
   *    from this software without prior written permission. For written
   *    permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache GroupImpl.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   *
   */
  package org.apache.commons.cli2.validation;
  
  import java.util.Iterator;
  import java.util.List;
  import java.util.Set;
  
  /**
   * A Validator for a list of known string values.
   * 
   * @author John Keyes
   */
  public class EnumValidator implements Validator {
  
      /** List of permitted values */
      private Set validValues;
      
      /** Stringified version of values */
      private String valuesStr;
      
      /**
       * Creates a new StringValidator for the specified values.
       *  
       * @param values
       *     the list of permitted values
       */
      public EnumValidator(final Set values) {
          this.validValues = values;
      }
      
      /**
       * Validate the list of values against the list
       * of permitted values. 
       * 
       * @see org.apache.commons.cli2.validation.Validator#validate(java.util.List)
       */
      public void validate(final List values) throws InvalidArgumentException {
          for (final Iterator iter = values.iterator(); iter.hasNext();) {
              final String value = (String) iter.next();
              
              if (!this.validValues.contains(value)) {
                  throw new InvalidArgumentException("'" + value + "' is not allowed.  Permitted
values are:"
                      + getValuesAsString());
              }
          }
      }
  
      /**
       * Returns the permitted values in a String
       * 
       * @return String
       *     formatted list of values
       */
      private String getValuesAsString() {
          final StringBuffer buff = new StringBuffer();
  
          buff.append("[");
          
          for (final Iterator iter = this.validValues.iterator(); 
              iter.hasNext();) {
                  
              buff.append("'").append(iter.next()).append("'");
              
              if (iter.hasNext()) {
                  buff.append(", ");
              }
          }
          
          buff.append("]");
  
          return buff.toString();
      }
  }
  
  
  

---------------------------------------------------------------------
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