InputField.java

/*
 * JBoss, Home of Professional Open Source
 * Copyright 2011, Red Hat, Inc., and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jboss.seam.faces.validation;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import javax.enterprise.util.Nonbinding;
import javax.faces.validator.FacesValidator;
import javax.inject.Qualifier;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * To be used in conjunction with <code><s:validateForm /></code> in Validators that should have their values fetched from
 * a JSF form field.
 * <p/>
 * Example:
 * <p/>
 * <code>
 * <p/>
 * public @{@link FacesValidator}("locationValidator") class
 * LocationValidator implements {@link Validator} {<p>
 * <p/>
 *     public @Field String city;<br/>    
 * public @Field String state;<br/>     public
 *
 * @author <a href="mailto:lincolnbaxter@gmail.com>Lincoln Baxter, III</a>
 * @Field("zip") String zipcode;<br/> <p>     public void validate(FacesContext context, UIComponent comp, Object
 * componentMap <br/>     {<br/>       
 * //validate like usual. <br/>     } <p> }</code>
 * <p/>
 * <b>Note:</b> The annotation value @Field("id") Specifies the default clientId alias for which values will be
 * bound to the field annotated by this annotation.
 * <p/>
 * <h:form id="form"><br/>
 *     <h:inputText id="cityId" value="#{bean.city}" /><br/>
 *     <h:inputText id="state" value="#{bean.state}" /><br/>
 *     <h:inputText id="zip" value="#{bean.zip}" /><br/>
 *     <h:commandButton id="submit" value="Submit"
 * action="#{bean.submit}" />
 * <p/>
 *     <s:validateForm fields="city=cityId"
 * validatorId="<b>locationValidator</b>" /><br/>
 * </h:form> </code>
 * <p/>
 * Notice in the above example, that not all fields must be specified in the validator tag. If the Facelet field
 * IDs match the validator fields, the values will automatically be mapped to the validator.
 * <p/>
 * Fields can also be mapped to the validator through a simple alias: "validatorFieldId=componentClientId", where
 * validatorFieldId is the name of the annotated @Field in the Validator, and componentClientId is the ID of the
 * input component relative to the form in which it resides.
 * <p/>
 * When writing your <b>public void validate(FacesContext context, UIComponent comp, Object componentMap)</b>
 * method, keep in mind the following differences from a normal validator:
 * <ul>
 * <li>"comp" is the parent UIForm that contains this <s:validateForm /> tag.</li>
 * <li>"componentMap" is a map of the requested input field names, and their corresponding UIInput component
 * objects. This allows programmatic access to each of the components being validated.</li>
 * </ul>
 */
@Qualifier
@Retention(RUNTIME)
@Target({FIELD, METHOD})
public @interface InputField {
    @Nonbinding
    public String value() default "";
}