src/commons/org/codehaus/groovy/grails/validation/InListConstraint.java

   1 /* Copyright 2004-2005 Graeme Rocher
   2  *
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at
   6  *
   7  *      http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 package org.codehaus.groovy.grails.validation;
  16
  17 import org.springframework.validation.Errors;
  18
  19 import java.util.List;
  20
  21 /**
  22  *  A constraint that validates the property is contained within the supplied list
  23  *
  24  * @author Graeme Rocher
  25  * @since 0.4
  26  *        <p/>
  27  *        Created: Jan 19, 2007
  28  *        Time: 8:21:24 AM
  29  */
  30 class InListConstraint extends AbstractConstraint {
  31
  32     List list;
  33
  34     /**
  35      * @return Returns the list.
  36      */
  37     public List getList() {
  38         return list;
  39     }
  40
  41     /* (non-Javadoc)
  42      * @see org.codehaus.groovy.grails.validation.Constraint#supports(java.lang.Class)
  43      */
  44     public boolean supports(Class type) {
  45         return type != null;
  46     }
  47
  48     /* (non-Javadoc)
  49      * @see org.codehaus.groovy.grails.validation.ConstrainedProperty.AbstractConstraint#setParameter(java.lang.Object)
  50      */
  51     public void setParameter(Object constraintParameter) {
  52         if(!(constraintParameter instanceof List))
  53             throw new IllegalArgumentException("Parameter for constraint ["+ConstrainedProperty.IN_LIST_CONSTRAINT+"] of property ["+constraintPropertyName+"] of class ["+constraintOwningClass+"] must implement the interface [java.util.List]");
  54
  55         this.list = (List)constraintParameter;
  56         super.setParameter(constraintParameter);
  57     }
  58
  59     public String getName() {
  60         return ConstrainedProperty.IN_LIST_CONSTRAINT;
  61     }
  62
  63     protected void processValidate(Object target, Object propertyValue, Errors errors) {
  64         // Check that the list contains the given value. If not, add
  65         // an error.
  66         if(!this.list.contains(propertyValue)) {
  67             Object[] args = new Object[] { constraintPropertyName, constraintOwningClass, propertyValue, list  };
  68             super.rejectValue(target,errors,ConstrainedProperty.DEFAULT_NOT_INLIST_MESSAGE_CODE,ConstrainedProperty.NOT_PREFIX + ConstrainedProperty.IN_LIST_CONSTRAINT,args);
  69         }
  70     }
  71
  72 }