org.hibernate.validator.internal.metadata.raw.ConstrainedElement Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source
* Copyright 2011, Red Hat, Inc. and/or its affiliates, 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.hibernate.validator.internal.metadata.raw;
import java.util.Map;
import java.util.Set;
import org.hibernate.validator.internal.metadata.core.MetaConstraint;
import org.hibernate.validator.internal.metadata.location.ConstraintLocation;
/**
* Represents a (potentially) constrained Java element such as a type, field or
* method. Such an element has a set of {@link org.hibernate.validator.internal.metadata.core.MetaConstraint}s and can be
* marked for a cascaded validation. Furthermore each constrained element has a
* {@link ConfigurationSource configuration source} which determines its origin.
*
* The hierarchy of constrained elements resembles the physical structure of the
* represented Java types. In particular it doesn't provide the notion of
* properties and it doesn't aggregate meta data for overridden elements in an
* inheritance hierarchy.
*
*
* Identity of implementations is based on the element location and constraint
* source. That means that for instance in a set there can be two configurations
* for one and the same Java field created by two different configuration
* sources (e.g. via annotation and XML) but not two configurations for the same
* field originating from one configuration source.
*
*
* Implementations are strictly read-only.
*
*
* @author Gunnar Morling
*/
public interface ConstrainedElement extends Iterable> {
/**
* The kind of a {@link ConstrainedElement}. Can be used to determine an
* element's type when traversing over a collection of constrained elements.
*
* @author Gunnar Morling
*/
public enum ConstrainedElementKind {
TYPE, FIELD, CONSTRUCTOR, METHOD, PARAMETER
}
/**
* Returns the kind of this constrained element.
*
* @return The kind of this constrained element.
*/
ConstrainedElementKind getKind();
/**
* Returns the location of this constrained element.
*
* @return The location of this constrained element.
*/
ConstraintLocation getLocation();
/**
* Returns a set containing the constraints specified for this constrained
* element.
*
* @return A set with this constrained element's constraints. May be empty,
* but never null
.
*/
Set> getConstraints();
/**
* Returns a map with the group conversions for this constrained element, as
* e.g. given using the {@code @ConvertGroup} annotation.
*
* @return A map with this constrained element's group conversions. May be
* empty, but never {@code null}.
*/
Map, Class> getGroupConversions();
/**
* Whether cascading validation for the represented element shall be
* performed or not.
*
* @return True
, if cascading validation for the represented
* element shall be performed, false
otherwise.
*/
boolean isCascading();
/**
* Whether this element is constrained or not. This is the case, if this
* element has at least one constraint or a cascaded validation shall be
* performed for it.
*
* @return True
, if this element is constrained,
* false
otherwise.
*/
boolean isConstrained();
}