FileDocCategorySizeDatePackage
MandatoryConstraint.javaAPI DocGlassfish v2 API4785Fri May 04 22:35:00 BST 2007com.sun.enterprise.tools.common.validation.constraints

MandatoryConstraint

public class MandatoryConstraint extends ConstraintUtils implements Constraint
MandatoryConstraint is a {@link Constraint} to validate non-null objects. It implements Constraint interface and extends {@link ConstraintUtils} class. match method of this object returns empty Collection if the value/object being validated is non null; else it returns a Collection with a {@link ConstraintFailure} object in it. ConstraintUtils class provides utility methods for formating failure messages and a print method to print this object.
author
Rajeshwar Patil
version
%I%, %G%

Fields Summary
Constructors Summary
public MandatoryConstraint()
Creates a new instance of MandatoryConstraint.

    
Methods Summary
public java.util.Collectionmatch(java.lang.String value, java.lang.String name)
Validates the given value against this Constraint.

param
value the value to be validated.
param
name the element name, value of which is being validated. It is used only in case of Constraint failure, to construct the failure message.
return
Collection the Collection of ConstraintFailure Objects. Collection is empty if there are no failures.

        return match((Object)value, name);
    
public java.util.Collectionmatch(java.lang.Object value, java.lang.String name)
Validates the given value against this Constraint.

param
value the value to be validated.
param
name the element name, value of which is being validated. It is used only in case of Constraint failure to construct the faiulure message.
return
Collection the Collection of ConstraintFailure Objects. Collection is empty if there are no failures. This method will fail, if the given vlaue is null.

        Collection failed_constrained_list = new ArrayList();
        if (null == value){
            String failureMessage = formatFailureMessage(toString(), name);
            failed_constrained_list.add(new ConstraintFailure(toString(), value,
                name, failureMessage, BundleReader.getValue(
                    "MSG_MandatoryConstraint_Failure")));               //NOI18N
        }
        return failed_constrained_list;