javax.validation.metadata.BeanDescriptor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of editors Show documentation
GWT Editors Parent
The newest version!
/*
 * Copyright © 2018 The GWT Authors
 *
 * 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 javax.validation.metadata;

import java.util.Set;

/**
 * Describes a constrained Java Bean and the constraints associated to it.
 *
 * @author Emmanuel Bernard
 */
public interface BeanDescriptor extends ElementDescriptor {
  /**
   * Returns true if the bean involves validation:
   *
   * 
   *   a constraint is hosted on the bean itself
   *   
a constraint is hosted on one of the bean properties
   *   
or a bean property is marked for cascade (@Valid)
   * 
   *
   * @return true if the bean involves validation, false otherwise.
   */
  boolean isBeanConstrained();

  /**
   * Return the property descriptor for a given property. Return null if the property
   * does not exist or has no constraint nor is marked as cascaded (see {@link
   * #getConstrainedProperties()} )
   *
   * The returned object (and associated objects including ConstraintDescriptors)
   * are immutable.
   *
   * @param propertyName property evaluated
   * @return the property descriptor for a given property.
   * @throws IllegalArgumentException if propertyName is null
   */
  PropertyDescriptor getConstraintsForProperty(String propertyName);

  /**
   * Returns a set of property descriptors having at least one constraint defined
   * or marked as cascaded (@Valid). If not property matches,
   * an empty set is returned.
   */
  Set getConstrainedProperties();
}