KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > j2ee > sun > validation > constraints > Constraint


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */

19
20 package org.netbeans.modules.j2ee.sun.validation.constraints;
21
22 import java.util.Collection JavaDoc;
23
24 /**
25  * Constraint is an <code>Interface</code> needed to perform a Validation.
26  * User can define a new type of Validation by implementing this
27  * <code>Interface</code>.
28  * Method <code>match</code> defines the Validation logic. This method
29  * returns an empty collection if the value being validated is valid;
30  * else it returns a <code>Collection</code> with a {@link ConstraintFailure}
31  * object in it.
32  *
33  * @author Rajeshwar Patil
34  * @version %I%, %G%
35  */

36 public interface Constraint {
37     /**
38      * Validates the given value against this <code>Constraint</code>.
39      *
40      * @param value the value to be validated
41      * @param name the element name, value of which is being validated.
42      *
43      * @return <code>Collection</code> the Collection of failure Objects.
44      * Collection is empty if there are no failures.
45      */

46     public Collection JavaDoc match(String JavaDoc value, String JavaDoc name);
47 }
48
Popular Tags