All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javax.faces.validator.Validator Maven / Gradle / Ivy

Go to download

This is the master POM file for Sun's Implementation of the JSF 2.1 Specification.

There is a newer version: 2.2.20
Show newest version
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2010 Oracle and/or its affiliates. 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_1_1.html
 * or packager/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 packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [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.validator;

import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import java.util.EventListener;


/**
 * 

A Validator * implementation is a class that can perform validation (correctness * checks) on a {@link javax.faces.component.EditableValueHolder}. Zero * or more Validators can be associated with each {@link * javax.faces.component.EditableValueHolder} in the view, and are * called during the Process Validations phase of the request * processing lifecycle.

*

*

Individual {@link Validator}s should examine the value and * component that they are passed, and throw a {@link ValidatorException} * containing a {@link javax.faces.application.FacesMessage}, documenting * any failures to conform to the required rules. *

*

For maximum generality, {@link Validator} instances may be * configurable based on properties of the {@link Validator} implementation * class. For example, a range check {@link Validator} might support * configuration of the minimum and maximum values to be used.

*

*

{@link Validator} implementations must have a zero-arguments * public constructor. In addition, if the {@link Validator} class * wishes to have configuration property values saved and restored with * the view, the implementation must also implement {@link * javax.faces.component.StateHolder}.

*

If the class implementing * Validator has a {@link * javax.faces.application.ResourceDependency} annotation, the action * described in ResourceDependency must be taken when * {@link javax.faces.component.EditableValueHolder#addValidator} is * called. If the class implementing Validator has a {@link * javax.faces.application.ResourceDependencies} annotation, the * action described in ResourceDependencies must be taken * when {@link javax.faces.component.EditableValueHolder#addValidator} * is called.

*/ public interface Validator extends EventListener { /** *

The message identifier of the {@link javax.faces.application.FacesMessage} to be created if * the maximum or minimum value check fails, and both the maximum * and minimum values for this validator have been set. The message * format string for this message may optionally include a * {0} placeholder, which will be replaced by the * configured minimum value, and a {1} placeholder, * which will be replaced by the configured maximum value.

* * @deprecated Use {@link DoubleRangeValidator#NOT_IN_RANGE_MESSAGE_ID} or * {@link LongRangeValidator#NOT_IN_RANGE_MESSAGE_ID} instead. */ public static final String NOT_IN_RANGE_MESSAGE_ID = "javax.faces.validator.NOT_IN_RANGE"; /** *

Perform the * correctness checks implemented by this {@link Validator} against * the specified {@link UIComponent}. If any violations are found, * a {@link ValidatorException} will be thrown containing the {@link * javax.faces.application.FacesMessage} describing the failure. * *

* *

For a validator to be fully compliant with Version 2 and later * of the specification, it must not fail validation on * null or empty values unless it is specifically * intended to address null or empty values. An * application-wide <context-param> is provided * to allow validators designed for JSF 1.2 to work with JSF 2 and * later. The javax.faces.VALIDATE_EMPTY_FIELDS * <context-param> must be set to * false to enable this backwards compatibility * behavior.

* *
* * @param context FacesContext for the request we are processing * @param component UIComponent we are checking for correctness * @param value the value to validate * @throws ValidatorException if validation fails * @throws NullPointerException if context * or component is null */ public void validate(FacesContext context, UIComponent component, Object value) throws ValidatorException; }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy