| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>ConstraintValidator</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="ConstraintValidator"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":18,"i1":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </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="../../javax/validation/ConstraintTarget.html" title="enum in javax.validation"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../javax/validation/ConstraintValidatorContext.html" title="interface in javax.validation"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?javax/validation/ConstraintValidator.html" target="_top">Frames</a></li> |
| <li><a href="ConstraintValidator.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</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">javax.validation</div> |
| <h2 title="Interface ConstraintValidator" class="title">Interface ConstraintValidator<A extends java.lang.annotation.Annotation,T></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>A</code> - the annotation type handled by an implementation</dd> |
| <dd><code>T</code> - the target type supported by an implementation</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">ConstraintValidator<A extends java.lang.annotation.Annotation,T></span></pre> |
| <div class="block">Defines the logic to validate a given constraint <code>A</code> |
| for a given object type <code>T</code>. |
| <p> |
| Implementations must comply to the following restriction: |
| <ul> |
| <li><code>T</code> must resolve to a non parameterized type</li> |
| <li>or generic parameters of <code>T</code> must be unbounded |
| wildcard types</li> |
| </ul> |
| <p> |
| The annotation <a href="../../javax/validation/constraintvalidation/SupportedValidationTarget.html" title="annotation in javax.validation.constraintvalidation"><code>SupportedValidationTarget</code></a> can be put on a |
| <code>ConstraintValidator</code> implementation to mark it as supporting |
| cross-parameter constraints. Check out <a href="../../javax/validation/constraintvalidation/SupportedValidationTarget.html" title="annotation in javax.validation.constraintvalidation"><code>SupportedValidationTarget</code></a> |
| and <a href="../../javax/validation/Constraint.html" title="annotation in javax.validation"><code>Constraint</code></a> for more information.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Examples (en):</span></dt> |
| <dd><a href="../../../../../tomee-8.0/examples/myfaces-codi-demo.html">myfaces-codi-demo</a>, <a href="../../../../../tomee-8.0/examples/mp-jwt-bean-validation.html">mp-jwt-bean-validation</a>, <a href="../../../../../tomee-8.0/examples/mp-jwt-bean-validation-strongly-typed.html">mp-jwt-bean-validation-strongly-typed</a>, <a href="../../../../../tomee-8.0/examples/deltaspike-fullstack.html">deltaspike-fullstack</a></dd> |
| <dt><span class="simpleTagLabel">Examples (es):</span></dt> |
| <dd><a href="../../../../../tomee-8.0/es/examples/myfaces-codi-demo.html">myfaces-codi-demo</a>, <a href="../../../../../tomee-8.0/es/examples/mp-jwt-bean-validation.html">mp-jwt-bean-validation</a></dd> |
| <dt><span class="simpleTagLabel">Examples (pt):</span></dt> |
| <dd><a href="../../../../../tomee-8.0/pt/examples/myfaces-codi-demo.html">myfaces-codi-demo</a>, <a href="../../../../../tomee-8.0/pt/examples/mp-jwt-bean-validation.html">mp-jwt-bean-validation</a>, <a href="../../../../../tomee-8.0/pt/examples/deltaspike-fullstack.html">deltaspike-fullstack</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/validation/ConstraintValidator.html#initialize-A-">initialize</a></span>(<a href="../../javax/validation/ConstraintValidator.html" title="type parameter in ConstraintValidator">A</a> constraintAnnotation)</code> |
| <div class="block">Initializes the validator in preparation for |
| <a href="../../javax/validation/ConstraintValidator.html#isValid-T-javax.validation.ConstraintValidatorContext-"><code>isValid(Object, ConstraintValidatorContext)</code></a> calls.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/validation/ConstraintValidator.html#isValid-T-javax.validation.ConstraintValidatorContext-">isValid</a></span>(<a href="../../javax/validation/ConstraintValidator.html" title="type parameter in ConstraintValidator">T</a> value, |
| <a href="../../javax/validation/ConstraintValidatorContext.html" title="interface in javax.validation">ConstraintValidatorContext</a> context)</code> |
| <div class="block">Implements the validation logic.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="initialize-java.lang.annotation.Annotation-"> |
| <!-- --> |
| </a><a name="initialize-A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initialize</h4> |
| <pre>default void initialize(<a href="../../javax/validation/ConstraintValidator.html" title="type parameter in ConstraintValidator">A</a> constraintAnnotation)</pre> |
| <div class="block">Initializes the validator in preparation for |
| <a href="../../javax/validation/ConstraintValidator.html#isValid-T-javax.validation.ConstraintValidatorContext-"><code>isValid(Object, ConstraintValidatorContext)</code></a> calls. |
| The constraint annotation for a given constraint declaration |
| is passed. |
| <p> |
| This method is guaranteed to be called before any use of this instance for |
| validation. |
| <p> |
| The default implementation is a no-op.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>constraintAnnotation</code> - annotation instance for a given constraint declaration</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isValid-java.lang.Object-javax.validation.ConstraintValidatorContext-"> |
| <!-- --> |
| </a><a name="isValid-T-javax.validation.ConstraintValidatorContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>isValid</h4> |
| <pre>boolean isValid(<a href="../../javax/validation/ConstraintValidator.html" title="type parameter in ConstraintValidator">T</a> value, |
| <a href="../../javax/validation/ConstraintValidatorContext.html" title="interface in javax.validation">ConstraintValidatorContext</a> context)</pre> |
| <div class="block">Implements the validation logic. |
| The state of <code>value</code> must not be altered. |
| <p> |
| This method can be accessed concurrently, thread-safety must be ensured |
| by the implementation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - object to validate</dd> |
| <dd><code>context</code> - context in which the constraint is evaluated</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>false</code> if <code>value</code> does not pass 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="../../javax/validation/ConstraintTarget.html" title="enum in javax.validation"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../javax/validation/ConstraintValidatorContext.html" title="interface in javax.validation"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?javax/validation/ConstraintValidator.html" target="_top">Frames</a></li> |
| <li><a href="ConstraintValidator.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
