| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>Constraint</title> |
| <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../script.js"></script> |
| |
| <link rel="shortcut icon" href="/img/jakarta-favicon.ico"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Constraint"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../index-all.html">Index</a></li> |
| <li><a href="../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../jakarta/validation/Configuration.html" title="interface in jakarta.validation"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../jakarta/validation/ConstraintDeclarationException.html" title="class in jakarta.validation"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/validation/Constraint.html" target="_top">Frames</a></li> |
| <li><a href="Constraint.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Field | </li> |
| <li><a href="#annotation.type.required.element.summary">Required</a> | </li> |
| <li>Optional</li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#annotation.type.element.detail">Element</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">jakarta.validation</div> |
| <h2 title="Annotation Type Constraint" class="title">Annotation Type Constraint</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>@Documented |
| @Target(value=ANNOTATION_TYPE) |
| @Retention(value=RUNTIME) |
| public @interface <span class="memberNameLabel">Constraint</span></pre> |
| <div class="block">Marks an annotation as being a Jakarta Bean Validation constraint. |
| <p> |
| A given constraint annotation must be annotated by a <code>@Constraint</code> |
| annotation which refers to its list of constraint validation implementations. |
| <p> |
| Each constraint annotation must host the following attributes: |
| <ul> |
| <li><code>String message() default [...];</code> which should default to an error |
| message key made of the fully-qualified class name of the constraint followed by |
| <code>.message</code>. For example <code>"{com.acme.constraints.NotSafe.message}"</code></li> |
| <li><code>Class<?>[] groups() default {};</code> for user to customize the targeted |
| groups</li> |
| <li><code>Class<? extends Payload>[] payload() default {};</code> for |
| extensibility purposes</li> |
| </ul> |
| <p> |
| When building a constraint that is both generic and cross-parameter, the constraint |
| annotation must host the <code>validationAppliesTo()</code> property. |
| A constraint is generic if it targets the annotated element and is cross-parameter if |
| it targets the array of parameters of a method or constructor. |
| <pre> |
| ConstraintTarget validationAppliesTo() default ConstraintTarget.IMPLICIT; |
| </pre> |
| This property allows the constraint user to choose whether the constraint |
| targets the return type of the executable or its array of parameters. |
| |
| A constraint is both generic and cross-parameter if |
| <ul> |
| <li>two kinds of <code>ConstraintValidator</code>s are attached to the |
| constraint, one targeting <a href="../../jakarta/validation/constraintvalidation/ValidationTarget.html#ANNOTATED_ELEMENT"><code>ValidationTarget.ANNOTATED_ELEMENT</code></a> |
| and one targeting <a href="../../jakarta/validation/constraintvalidation/ValidationTarget.html#PARAMETERS"><code>ValidationTarget.PARAMETERS</code></a>,</li> |
| <li>or if a <code>ConstraintValidator</code> targets both |
| <code>ANNOTATED_ELEMENT</code> and <code>PARAMETERS</code>.</li> |
| </ul> |
| |
| Such dual constraints are rare. See <a href="../../jakarta/validation/constraintvalidation/SupportedValidationTarget.html" title="annotation in jakarta.validation.constraintvalidation"><code>SupportedValidationTarget</code></a> for more info. |
| <p> |
| Here is an example of constraint definition: |
| <pre> |
| @Documented |
| @Constraint(validatedBy = OrderNumberValidator.class) |
| @Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE }) |
| @Retention(RUNTIME) |
| public @interface OrderNumber { |
| String message() default "{com.acme.constraint.OrderNumber.message}"; |
| Class<?>[] groups() default {}; |
| Class<? extends Payload>[] payload() default {}; |
| } |
| </pre></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Examples (en):</span></dt> |
| <dd><a href="../../../../../tomee-9.0/examples/deltaspike-fullstack.html">deltaspike-fullstack</a></dd> |
| <dt><span class="simpleTagLabel">Examples (pt):</span></dt> |
| <dd><a href="../../../../../tomee-9.0/pt/examples/deltaspike-fullstack.html">deltaspike-fullstack</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="annotation.type.required.element.summary"> |
| <!-- --> |
| </a> |
| <h3>Required Element Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation"> |
| <caption><span>Required Elements</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Required Element and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>java.lang.Class<? extends <a href="../../jakarta/validation/ConstraintValidator.html" title="interface in jakarta.validation">ConstraintValidator</a><?,?>>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/validation/Constraint.html#validatedBy--">validatedBy</a></span></code> |
| <div class="block"><a href="../../jakarta/validation/ConstraintValidator.html" title="interface in jakarta.validation"><code>ConstraintValidator</code></a> classes implementing the constraint.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="annotation.type.element.detail"> |
| <!-- --> |
| </a> |
| <h3>Element Detail</h3> |
| <a name="validatedBy--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>validatedBy</h4> |
| <pre>public abstract java.lang.Class<? extends <a href="../../jakarta/validation/ConstraintValidator.html" title="interface in jakarta.validation">ConstraintValidator</a><?,?>>[] validatedBy</pre> |
| <div class="block"><a href="../../jakarta/validation/ConstraintValidator.html" title="interface in jakarta.validation"><code>ConstraintValidator</code></a> classes implementing the constraint. The given classes |
| must reference distinct target types for a given <a href="../../jakarta/validation/constraintvalidation/ValidationTarget.html" title="enum in jakarta.validation.constraintvalidation"><code>ValidationTarget</code></a>. If two |
| <code>ConstraintValidator</code>s refer to the same type, an exception will occur. |
| <p> |
| At most one <code>ConstraintValidator</code> targeting the array of parameters of |
| methods or constructors (aka cross-parameter) is accepted. If two or more |
| are present, an exception will occur.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>array of <code>ConstraintValidator</code> classes implementing the constraint</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../index-all.html">Index</a></li> |
| <li><a href="../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../jakarta/validation/Configuration.html" title="interface in jakarta.validation"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../jakarta/validation/ConstraintDeclarationException.html" title="class in jakarta.validation"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/validation/Constraint.html" target="_top">Frames</a></li> |
| <li><a href="Constraint.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Field | </li> |
| <li><a href="#annotation.type.required.element.summary">Required</a> | </li> |
| <li>Optional</li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#annotation.type.element.detail">Element</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |