com.google.gwt.validation.client.GwtValidation Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of gwt-user Show documentation
The newest version!
/*
 * Copyright 2010 Google Inc.
 *
 * 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 com.google.gwt.validation.client;

import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

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

import javax.validation.groups.Default;

/**
 * Annotates a {@code javax.validation.Validator} explicitly listing the classes
 * that can be validated in GWT.
 * 
 * Define the Validator you want, explicitly listing the classes and groups 
 * you want to validate.
 * 
 * 
 * @GwtValidation(value = {MyBean.class, MyOther.class},
 *     groups = {Default.class, OtherGroup.class})
 * public interface MyValidator extends javax.validation.Validator {
 * }
 * 
 * Create and use the validator.
 * 
 *  * MyValidator validator = GWT.create(MyValidator.class);
 * MyBean bean = new MyBean();
 * ...
 * Set<ConstraintViolation<MyBean>> violations = validator.validate(bean);
 * 
 * 
 * 
 * You must list all validation groups you are using (as well as groups
 * making up a group sequence)– unless you are only using the Default group,
 * in which case you may omit the "groups" field of the {@link GwtValidation}
 * annotation.
 * 
 * 

 * NOTE: Validation is done using only the Constraints found on the Classes
 * listed in the annotation. If you have
 * 
 * 
 * class MyBean {
 *  @Null
 *  String getName(){return name;}
 * }
 * class MySubBean extends MyBean {
 *   @Size(min = 5)
 *   String getName(){return super.getName();}
 * }
 * 
 * 
 * And then create your {@link javax.validation.ValidatorFactory
 * ValidatorFactory} using
 * 
 *  * @GwtValidation(MyBean.class, MyOther.class)}
 * 
 * 
 * but call validator with the subclass like
 * 
 *  * MySubBean bean = new MySubBean();
 * Set<ConstraintViolation<MyBean>> violations = validator.validate(bean);
 * 
 * 
 * The {@code Size} constraint will not be validated.
 * 
 * Instead make sure you list the all BeanTypes that will be directly validated
 * in the {@link GwtValidation} annotation.
 * 
 * 
 */
@Documented
@Target(TYPE)
@Retention(RUNTIME)
public @interface GwtValidation {

  /**
   * The list of Groups which can be processed by the annotated
   * {@code Validator}. The default value is {@link Default}.
   * An empty array is illegal.
   */
  Class[] groups() default {Default.class};

  /**
   * The list of Classes which can be validated by the annotated
   * {@code Validator}.
   */
  Class[] value();
}