com.google.gwt.validation.client.constraints.NotGwtCompatibleValidator Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of gwt-servlet Show documentation

There is a newer version: 2.10.0

/*
 * 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.constraints;

import java.lang.annotation.Annotation;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

/**
 * EXPERIMENTAL and subject to change. Do not use this in
 * production code.
 * 
 * Masks a {@link ConstraintValidator} that is not GWT compatible. This
 * validator always fails.
 * 

 * Extend this class and implement it as GWT super class. Use validation groups
 * to keep this constraint from being validated on the client.
 * 
 * 

 * In a super source directory override your validator like this:
 * 
 * 
 * public class MyValidator extends
 *     NotGwtCompatibleValidator <MyConstraint, MyType>{
 * }
 * 
 * 
 * @param  the constraint to validate
 * @param  the type to validate
 */
public abstract class NotGwtCompatibleValidator
    implements ConstraintValidator {

  public final void initialize(A constraintAnnotation) {
  }

  /**
   * Always fails.
   */
  public final boolean isValid(T value, ConstraintValidatorContext context) {
    // TODO (nchalko) add a custom message
    return false;
  }

}