Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * $Id: ValidatorTag.java,v 1.26 2007/04/27 22:00:12 ofung Exp $
   */
  
  /*
   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
   * 
   * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
   * 
  * The contents of this file are subject to the terms of either the GNU
  * General Public License Version 2 only ("GPL") or the Common Development
  * and Distribution License("CDDL") (collectively, the "License").  You
  * may not use this file except in compliance with the License. You can obtain
  * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
  * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
  * language governing permissions and limitations under the License.
  * 
  * When distributing the software, include this License Header Notice in each
  * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
  * Sun designates this particular file as subject to the "Classpath" exception
  * as provided by Sun in the GPL Version 2 section of the License file that
  * accompanied this code.  If applicable, add the following below the License
  * Header, with the fields enclosed by brackets [] replaced by your own
  * identifying information: "Portions Copyrighted [year]
  * [name of copyright owner]"
  * 
  * Contributor(s):
  * 
  * If you wish your version of this file to be governed by only the CDDL or
  * only the GPL Version 2, indicate your decision by adding "[Contributor]
  * elects to include this software in this distribution under the [CDDL or GPL
  * Version 2] license."  If you don't indicate a single choice of license, a
  * recipient has the option to distribute your version of this file under
  * either the CDDL, the GPL Version 2 or to extend the choice of license to
  * its licensees as provided above.  However, if you add GPL Version 2 code
  * and therefore, elected the GPL Version 2 license, then the option applies
  * only if the new code is made subject to such option by the copyright
  * holder.
  */
 
 package javax.faces.webapp;
 

ValidatorTag is a base class for all JSP custom actions that create and register a Validator instance on the javax.faces.component.EditableValueHolder associated with our most immediate surrounding instance of a tag whose implementation class is a subclass of UIComponentTag. To avoid creating duplicate instances when a page is redisplayed, creation and registration of a javax.faces.validator.Validator occurs only if the corresponding javax.faces.component.UIComponent was created (by the owning UIComponentTag) during the execution of the current page.

This class may be used directly to implement a generic validator registration tag (based on the validator-id specified by the id attribute), or as a base class for tag instances that support specific javax.faces.validator.Validator subclasses. This id attribute must refer to one of the well known validator-ids, or a custom validator-id as defined in a faces-config.xml file.

Subclasses of this class must implement the createValidator() method, which creates and returns a javax.faces.validator.Validator instance. Any configuration properties that specify the limits to be enforced by this javax.faces.validator.Validator must have been set by the createValidator() method. Generally, this occurs by copying corresponding attribute values on the tag instance.

This tag creates no output to the page currently being created. It is used solely for the side effect of javax.faces.validator.Validator creation.

Deprecated:
This has been partially replaced by ValidatorELTag. The remainder of the functionality, namely, the binding facility and the implementation of the createValidator() method, is now an implementation detail.
 
 
 public class ValidatorTag extends TagSupport {
 
 
     // ---------------------------------------------------------- Static Members
 
 
     private static final long serialVersionUID = -5562623615418158868L;
 
 
     // ------------------------------------------------------------- Attributes
 
    

The identifier of the javax.faces.validator.Validator instance to be created.

    private String validatorId = null;
    
    

The javax.el.ValueExpression that evaluates to an object that implements javax.faces.validator.Validator.

    private String binding = null;

    

Set the identifer of the javax.faces.validator.Validator instance to be created.

Parameters:
validatorId The new identifier of the validator instance to be created.
    public void setValidatorId(String validatorId) {
        this. = validatorId;
    }

    

Set the expression that will be used to create a javax.el.ValueExpression that references a backing bean property of the javax.faces.validator.Validator instance to be created.

Parameters:
binding The new expression
Throws:
javax.servlet.jsp.JspException if a JSP error occurs
    public void setBinding(String binding
        throws JspException {
        if (binding != null && !UIComponentTag.isValueReference(binding)) {
            //PENDING i18n
            throw new JspException("Invalid Expression:"+binding);
        }
        this. = binding;
    }
    // --------------------------------------------------------- Public Methods


    

Create a new instance of the specified javax.faces.validator.Validator class, and register it with the javax.faces.component.UIComponent instance associated with our most immediately surrounding UIComponentTag instance, if the javax.faces.component.UIComponent instance was created by this execution of the containing JSP page.

Throws:
javax.servlet.jsp.JspException if a JSP error occurs
    public int doStartTag() throws JspException {
        
        // Locate our parent UIComponentTag
        UIComponentClassicTagBase tag =
             UIComponentClassicTagBase.getParentUIComponentClassicTagBase();
        if (tag == null) { 
       	    //PENDING i18n
            throw new JspException("Not nested in a UIComponentTag Error for tag with handler class:"+
                    this.getClass().getName());
        }
        // Nothing to do unless this tag created a component
        if (!tag.getCreated()) {
            return ();
        }
        
        UIComponent component = tag.getComponentInstance();
        if (component == null) {            
            //PENDING i18n
            throw new JspException("Can't create Component from tag.");
        }
        if (!(component instanceof EditableValueHolder)) {
            // PENDING i18n
            throw new JspException("Not nested in a tag of proper type. Error for tag with handler class:"+
                    this.getClass().getName());
        }
        Validator validator = createValidator();
        
        if (validator == null) {
            //noinspection NonConstantStringShouldBeStringBuffer
            String validateError = null;
            if ( != null) {
                validateError = ;
            }
            if ( != null) {
                if (validateError != null) {
                    validateError += " or " + ;
                } else {
                    validateError = ;
                }
            }
                
            // PENDING i18n
            throw new JspException("Can't create class of type:"+
                "javax.faces.validator.Validator from:"+validateError);
        }
        // Register an instance with the appropriate component
        ((EditableValueHolder)component).addValidator(validator);
        
        return ();
    }


    

Release references to any acquired resources.

    public void release() {
        this. = null;
    }
    // ------------------------------------------------------ Protected Methods


    

Create and return a new javax.faces.validator.Validator to be registered on our surrounding javax.faces.component.UIComponent.

Throws:
javax.servlet.jsp.JspException if a new instance cannot be created
    protected Validator createValidator()
        throws JspException {
        
        FacesContext context = FacesContext.getCurrentInstance();
        Validator validator = null;
        ValueExpression vb = null;
        
        // If "binding" is set, use it to create a validator instance.
        if ( != null) {
            try {
                vb = context.getApplication().getExpressionFactory().createValueExpression(context.getELContext(), 
                        Object.class);
                if (vb != null) {
                    validator = (Validator)vb.getValue(context.getELContext());
                    if (validator != null) {
                        return validator;
                    }
                }
            } catch (Exception e) {
                throw new JspException(e);
            }
        } 
        // If "validatorId" is set, use it to create the validator
        // instance.  If "validatorId" and "binding" are both set, store the 
        // validator instance in the value of the property represented by
        // the value binding expression.      
        if ( != null) {
            try {
                String validatorIdVal = ;
                if (UIComponentTag.isValueReference()) {
                    ValueExpression idBinding = context.getApplication().
                        getExpressionFactory().createValueExpression(context.getELContext(), 
                            Object.class);
                    validatorIdVal = (String)idBinding.getValue(context.getELContext());
                }
                validator = context.getApplication().createValidator(validatorIdVal);
                if (validator != null) { 
                    if (vb != null) {
                        vb.setValue(context.getELContext(), validator);
                    }
                }
            } catch (Exception e) {
                throw new JspException(e);
            }
        }
        return validator;
    }
New to GrepCode? Check out our FAQ X