View Javadoc

1   /*
2    * Copyright 2004-2009 the original author or authors.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.springmodules.validation.bean.conf.loader.xml.handler;
18  
19  import java.beans.PropertyDescriptor;
20  
21  import org.springmodules.validation.bean.conf.MutableBeanValidationConfiguration;
22  import org.w3c.dom.Element;
23  
24  /**
25   * An handler that handles property level validation dom elements and manipulates the validation configuration
26   * appropriately.
27   *
28   * @author Uri Boness
29   */
30  public interface PropertyValidationElementHandler {
31  
32      /**
33       * Determines whether this handler can handle the given element.
34       *
35       * @param element The element to be handled.
36       * @param clazz The validated clazz.
37       * @param descriptor The property descriptor of the validated property.
38       * @return <code>true</code> if this handler can handle the given element, <code>false</code> otherwise.
39       */
40      boolean supports(Element element, Class clazz, PropertyDescriptor descriptor);
41  
42      /**
43       * Handles the given element and and manipulates the given configuration appropriately.
44       *
45       * @param element The element to be handled.
46       * @param propertyName The name of the validated property.
47       * @param configuration The configuration to be manipulated.
48       */
49      void handle(Element element, String propertyName, MutableBeanValidationConfiguration configuration);
50  
51  }