ConstraintDescriptorImpl.java

/*
 * Copyright 2010 Google Inc. Copyright 2016 Manfred Tremmel
 *
 * 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 de.knightsoftnet.validators.client.impl;

import org.hibernate.validator.internal.metadata.core.ConstraintHelper;

import java.lang.annotation.Annotation;
import java.lang.annotation.ElementType;
import java.util.Arrays;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;

import javax.validation.ConstraintTarget;
import javax.validation.ConstraintValidator;
import javax.validation.Payload;
import javax.validation.metadata.ConstraintDescriptor;

/**
 * A immutable GWT implementation of {@link ConstraintDescriptor}.
 *
 * @param <T> the constraint annotation to describe.
 */
public class ConstraintDescriptorImpl<T extends Annotation> implements ConstraintDescriptor<T> {

  /**
   * Builder for {@link ConstraintDescriptorImpl}.
   *
   * @param <T> the constraint annotation to describe.
   */
  public static class Builder<T extends Annotation> {
    private T annotation;
    private Set<Class<?>> groups;
    private Set<Class<? extends Payload>> payload;
    private List<Class<? extends ConstraintValidator<T, ?>>> constraintValidatorClasses;
    private Map<String, Object> attributes;
    private final Set<ConstraintDescriptor<?>> composingConstraints =
        new HashSet<>();
    private boolean reportAsSingleViolation;
    private ElementType elementType;
    private ConstraintOrigin definedOn;

    public Builder<T> addComposingConstraint(final ConstraintDescriptor<?> composingConstraint) {
      this.composingConstraints.add(composingConstraint);
      return this;
    }

    /**
     * build new ConstraintDescriptorImpl.
     *
     * @return created ConstraintDescriptorImpl
     */
    public ConstraintDescriptorImpl<T> build() {
      return new ConstraintDescriptorImpl<>( // NOPMD
          this.annotation, //
          this.groups, //
          this.payload, //
          this.constraintValidatorClasses, //
          this.attributes, //
          this.composingConstraints, //
          this.reportAsSingleViolation, //
          this.elementType, //
          this.definedOn);
    }

    public Builder<T> setAnnotation(final T annotation) {
      this.annotation = annotation;
      return this;
    }

    public Builder<T> setAttributes(final Map<String, Object> attributes) {
      this.attributes = attributes;
      return this;
    }

    /**
     * setter for constraint validator class.
     *
     * @param constraintValidatorClasses value to set
     * @return this class
     */
    public Builder<T> setConstraintValidatorClasses(
        final Class<? extends ConstraintValidator<T, ?>>[] constraintValidatorClasses) {
      final List<Class<? extends ConstraintValidator<T, ?>>> list =
          Arrays.asList(constraintValidatorClasses);
      this.setConstraintValidatorClasses(list);
      return this;
    }

    public Builder<T> setConstraintValidatorClasses(
        final List<Class<? extends ConstraintValidator<T, ?>>> constraintValidatorClasses) {
      this.constraintValidatorClasses = constraintValidatorClasses;
      return this;
    }

    public Builder<T> setDefinedOn(final ConstraintOrigin definedOn) {
      this.definedOn = definedOn;
      return this;
    }

    public Builder<T> setElementType(final ElementType elementType) {
      this.elementType = elementType;
      return this;
    }

    public Builder<T> setGroups(final Class<?>[] classes) {
      this.setGroups(new HashSet<>(Arrays.asList(classes)));
      return this;
    }

    public Builder<T> setGroups(final Set<Class<?>> groups) {
      this.groups = groups;
      return this;
    }

    public Builder<T> setPayload(final Class<? extends Payload>[] classes) {
      this.setPayload(new HashSet<>(Arrays.asList(classes)));
      return this;
    }

    public Builder<T> setPayload(final Set<Class<? extends Payload>> payload) {
      this.payload = payload;
      return this;
    }

    public Builder<T> setReportAsSingleViolation(final boolean reportAsSingleViolation) {
      this.reportAsSingleViolation = reportAsSingleViolation;
      return this;
    }
  }

  public static <T extends Annotation> Builder<T> builder() {
    return new Builder<>();
  }

  private final T annotation;
  private final Set<Class<?>> groups;
  private final Set<Class<? extends Payload>> payload;
  private final List<Class<? extends ConstraintValidator<T, ?>>> constraintValidatorClasses;
  private final Map<String, Object> attributes;
  private final Set<ConstraintDescriptor<?>> composingConstraints;
  private final boolean reportAsSingleViolation;
  private final ElementType elementType;
  private final ConstraintOrigin definedOn;

  protected ConstraintDescriptorImpl(final T annotation, final Set<Class<?>> groups,
      final Set<Class<? extends Payload>> payload,
      final List<Class<? extends ConstraintValidator<T, ?>>> constraintValidatorClasses,
      final Map<String, Object> attributes, final Set<ConstraintDescriptor<?>> composingConstraints,
      final boolean reportAsSingleViolation, final ElementType elementType,
      final ConstraintOrigin definedOn) {
    super();
    this.annotation = annotation;
    this.groups = groups;
    this.payload = payload;
    this.constraintValidatorClasses = constraintValidatorClasses;
    this.attributes = attributes;
    this.composingConstraints = composingConstraints;
    this.reportAsSingleViolation = reportAsSingleViolation;
    this.elementType = elementType;
    this.definedOn = definedOn;
  }

  @Override
  public T getAnnotation() {
    return this.annotation;
  }

  @Override
  public String getMessageTemplate() {
    return (String) this.getAttributes().get(ConstraintHelper.MESSAGE);
  }

  @Override
  public Map<String, Object> getAttributes() {
    return this.attributes;
  }

  @Override
  public Set<ConstraintDescriptor<?>> getComposingConstraints() {
    return this.composingConstraints;
  }

  @Override
  public List<Class<? extends ConstraintValidator<T, ?>>> getConstraintValidatorClasses() {
    return this.constraintValidatorClasses;
  }

  public ConstraintOrigin getDefinedOn() {
    return this.definedOn;
  }

  public ElementType getElementType() {
    return this.elementType;
  }

  @Override
  public Set<Class<?>> getGroups() {
    return this.groups;
  }

  @Override
  public Set<Class<? extends Payload>> getPayload() {
    return this.payload;
  }

  @Override
  public ConstraintTarget getValidationAppliesTo() {
    return (ConstraintTarget) this.attributes.get(ConstraintHelper.VALIDATION_APPLIES_TO);
  }

  @Override
  public boolean isReportAsSingleViolation() {
    return this.reportAsSingleViolation;
  }

  /**
   * For debugging only. Do not rely on the format. It can change at any time.
   */
  @Override
  public String toString() {
    return String.valueOf(this.annotation);
  }
}