KickJava   Java API By Example, From Geeks To Geeks.

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


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.ArrayList JavaDoc;
23 import java.util.Collection JavaDoc;
24
25 import org.netbeans.modules.j2ee.sun.validation.constraints.ConstraintFailure;
26 import org.netbeans.modules.j2ee.sun.validation.util.BundleReader;
27
28 /**
29  * MandatoryConstraint is a {@link Constraint} to validate non-null objects.
30  * It implements <code>Constraint</code> interface and extends
31  * {@link ConstraintUtils} class.
32  * <code>match</code> method of this object returns empty
33  * <code>Collection</code> if the value/object being validated is non
34  * <code>null</code>; else it returns a <code>Collection</code> with a
35  * {@link ConstraintFailure} object in it. <code>ConstraintUtils</code> class
36  * provides utility methods for formating failure messages and a
37  * <code>print<method> method to print this object.
38  *
39  * @author Rajeshwar Patil
40  * @version %I%, %G%
41  */

42 public class MandatoryConstraint extends ConstraintUtils
43                 implements Constraint{
44     
45     /** Creates a new instance of <code>MandatoryConstraint</code>. */
46     public MandatoryConstraint() {
47     }
48
49
50     /**
51      * Validates the given value against this <code>Constraint</code>.
52      *
53      * @param value the value to be validated.
54      * @param name the element name, value of which is being validated.
55      * It is used only in case of <code>Constraint</code> failure, to construct
56      * the failure message.
57      *
58      * @return <code>Collection</code> the Collection of
59      * <code>ConstraintFailure</code> Objects. Collection is empty if
60      * there are no failures.
61      */

62     public Collection JavaDoc match(String JavaDoc value, String JavaDoc name) {
63         return match((Object JavaDoc)value, name);
64     }
65
66
67     /**
68      * Validates the given value against this <code>Constraint</code>.
69      *
70      * @param value the value to be validated.
71      * @param name the element name, value of which is being validated.
72      * It is used only in case of <code>Constraint</code> failure to construct
73      * the faiulure message.
74      *
75      * @return <code>Collection</code> the Collection of
76      * <code>ConstraintFailure</code> Objects. Collection is empty if
77      * there are no failures. This method will fail, if the given vlaue is null.
78      */

79     public java.util.Collection JavaDoc match(Object JavaDoc value, String JavaDoc name) {
80         Collection JavaDoc failed_constrained_list = new ArrayList JavaDoc();
81         if (null == value){
82             String JavaDoc failureMessage = formatFailureMessage(toString(), name);
83             failed_constrained_list.add(new ConstraintFailure(toString(), value,
84                 name, failureMessage, BundleReader.getValue(
85                     "MSG_MandatoryConstraint_Failure"))); //NOI18N
86
}
87         return failed_constrained_list;
88     }
89 }
90
Popular Tags