| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>ValidatorFactory</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="ValidatorFactory"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="../../jakarta/validation/ValidatorContext.html" title="interface in jakarta.validation"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/validation/ValidatorFactory.html" target="_top">Frames</a></li> |
| <li><a href="ValidatorFactory.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">jakarta.validation</div> |
| <h2 title="Interface ValidatorFactory" class="title">Interface ValidatorFactory</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd>java.lang.AutoCloseable</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">ValidatorFactory</span> |
| extends java.lang.AutoCloseable</pre> |
| <div class="block">Factory returning initialized <code>Validator</code> instances. |
| <p> |
| Implementations are thread-safe and instances are typically cached and reused.</div> |
| </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></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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/validation/ValidatorFactory.html#close--">close</a></span>()</code> |
| <div class="block">Closes the <code>ValidatorFactory</code> instance.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../jakarta/validation/ClockProvider.html" title="interface in jakarta.validation">ClockProvider</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/validation/ValidatorFactory.html#getClockProvider--">getClockProvider</a></span>()</code> |
| <div class="block">Returns the <a href="../../jakarta/validation/ClockProvider.html" title="interface in jakarta.validation"><code>ClockProvider</code></a> instance configured at |
| initialization time for the <code>ValidatorFactory</code>.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../jakarta/validation/ConstraintValidatorFactory.html" title="interface in jakarta.validation">ConstraintValidatorFactory</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/validation/ValidatorFactory.html#getConstraintValidatorFactory--">getConstraintValidatorFactory</a></span>()</code> |
| <div class="block">Returns the <a href="../../jakarta/validation/ConstraintValidatorFactory.html" title="interface in jakarta.validation"><code>ConstraintValidatorFactory</code></a> instance |
| configured at initialization time for the |
| <code>ValidatorFactory</code>.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../jakarta/validation/MessageInterpolator.html" title="interface in jakarta.validation">MessageInterpolator</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/validation/ValidatorFactory.html#getMessageInterpolator--">getMessageInterpolator</a></span>()</code> |
| <div class="block">Returns the <a href="../../jakarta/validation/MessageInterpolator.html" title="interface in jakarta.validation"><code>MessageInterpolator</code></a> instance configured at |
| initialization time for the <code>ValidatorFactory</code>.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../jakarta/validation/ParameterNameProvider.html" title="interface in jakarta.validation">ParameterNameProvider</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/validation/ValidatorFactory.html#getParameterNameProvider--">getParameterNameProvider</a></span>()</code> |
| <div class="block">Returns the <a href="../../jakarta/validation/ParameterNameProvider.html" title="interface in jakarta.validation"><code>ParameterNameProvider</code></a> instance configured at |
| initialization time for the <code>ValidatorFactory</code>.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../jakarta/validation/TraversableResolver.html" title="interface in jakarta.validation">TraversableResolver</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/validation/ValidatorFactory.html#getTraversableResolver--">getTraversableResolver</a></span>()</code> |
| <div class="block">Returns the <a href="../../jakarta/validation/TraversableResolver.html" title="interface in jakarta.validation"><code>TraversableResolver</code></a> instance configured |
| at initialization time for the <code>ValidatorFactory</code>.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../jakarta/validation/Validator.html" title="interface in jakarta.validation">Validator</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/validation/ValidatorFactory.html#getValidator--">getValidator</a></span>()</code> |
| <div class="block">Returns an initialized <a href="../../jakarta/validation/Validator.html" title="interface in jakarta.validation"><code>Validator</code></a> instance using the |
| factory defaults for message interpolator, traversable resolver |
| and constraint validator factory.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/validation/ValidatorFactory.html#unwrap-java.lang.Class-">unwrap</a></span>(java.lang.Class<T> type)</code> |
| <div class="block">Returns an instance of the specified type allowing access to |
| provider-specific APIs.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../jakarta/validation/ValidatorContext.html" title="interface in jakarta.validation">ValidatorContext</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/validation/ValidatorFactory.html#usingContext--">usingContext</a></span>()</code> |
| <div class="block">Defines a new validator context and returns a <code>Validator</code> |
| compliant this new context.</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="getValidator--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValidator</h4> |
| <pre><a href="../../jakarta/validation/Validator.html" title="interface in jakarta.validation">Validator</a> getValidator()</pre> |
| <div class="block">Returns an initialized <a href="../../jakarta/validation/Validator.html" title="interface in jakarta.validation"><code>Validator</code></a> instance using the |
| factory defaults for message interpolator, traversable resolver |
| and constraint validator factory. |
| <p> |
| Validator instances can be pooled and shared by the implementation.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an initialized <code>Validator</code> instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="usingContext--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>usingContext</h4> |
| <pre><a href="../../jakarta/validation/ValidatorContext.html" title="interface in jakarta.validation">ValidatorContext</a> usingContext()</pre> |
| <div class="block">Defines a new validator context and returns a <code>Validator</code> |
| compliant this new context.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <a href="../../jakarta/validation/ValidatorContext.html" title="interface in jakarta.validation"><code>ValidatorContext</code></a> instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMessageInterpolator--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMessageInterpolator</h4> |
| <pre><a href="../../jakarta/validation/MessageInterpolator.html" title="interface in jakarta.validation">MessageInterpolator</a> getMessageInterpolator()</pre> |
| <div class="block">Returns the <a href="../../jakarta/validation/MessageInterpolator.html" title="interface in jakarta.validation"><code>MessageInterpolator</code></a> instance configured at |
| initialization time for the <code>ValidatorFactory</code>. |
| This is the instance used by <a href="../../jakarta/validation/ValidatorFactory.html#getValidator--"><code>getValidator()</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>MessageInterpolator</code> instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTraversableResolver--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTraversableResolver</h4> |
| <pre><a href="../../jakarta/validation/TraversableResolver.html" title="interface in jakarta.validation">TraversableResolver</a> getTraversableResolver()</pre> |
| <div class="block">Returns the <a href="../../jakarta/validation/TraversableResolver.html" title="interface in jakarta.validation"><code>TraversableResolver</code></a> instance configured |
| at initialization time for the <code>ValidatorFactory</code>. |
| This is the instance used by <a href="../../jakarta/validation/ValidatorFactory.html#getValidator--"><code>getValidator()</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>TraversableResolver</code> instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getConstraintValidatorFactory--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConstraintValidatorFactory</h4> |
| <pre><a href="../../jakarta/validation/ConstraintValidatorFactory.html" title="interface in jakarta.validation">ConstraintValidatorFactory</a> getConstraintValidatorFactory()</pre> |
| <div class="block">Returns the <a href="../../jakarta/validation/ConstraintValidatorFactory.html" title="interface in jakarta.validation"><code>ConstraintValidatorFactory</code></a> instance |
| configured at initialization time for the |
| <code>ValidatorFactory</code>. |
| This is the instance used by <a href="../../jakarta/validation/ValidatorFactory.html#getValidator--"><code>getValidator()</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>ConstraintValidatorFactory</code> instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getParameterNameProvider--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParameterNameProvider</h4> |
| <pre><a href="../../jakarta/validation/ParameterNameProvider.html" title="interface in jakarta.validation">ParameterNameProvider</a> getParameterNameProvider()</pre> |
| <div class="block">Returns the <a href="../../jakarta/validation/ParameterNameProvider.html" title="interface in jakarta.validation"><code>ParameterNameProvider</code></a> instance configured at |
| initialization time for the <code>ValidatorFactory</code>. |
| This is the instance used by #getValidator().</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>ParameterNameProvider</code> instance</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getClockProvider--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClockProvider</h4> |
| <pre><a href="../../jakarta/validation/ClockProvider.html" title="interface in jakarta.validation">ClockProvider</a> getClockProvider()</pre> |
| <div class="block">Returns the <a href="../../jakarta/validation/ClockProvider.html" title="interface in jakarta.validation"><code>ClockProvider</code></a> instance configured at |
| initialization time for the <code>ValidatorFactory</code>. |
| This is the instance used by #getValidator().</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>ClockProvider</code> instance</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="unwrap-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unwrap</h4> |
| <pre><T> T unwrap(java.lang.Class<T> type)</pre> |
| <div class="block">Returns an instance of the specified type allowing access to |
| provider-specific APIs. If the Jakarta Bean Validation provider |
| implementation does not support the specified class, a |
| <code>ValidationException</code> is thrown.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the type of the object to be returned</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>type</code> - the class of the object to be returned</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an instance of the specified class</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../jakarta/validation/ValidationException.html" title="class in jakarta.validation">ValidationException</a></code> - if the provider does not |
| support the call.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>void close()</pre> |
| <div class="block">Closes the <code>ValidatorFactory</code> instance. |
| |
| After the <code>ValidatorFactory</code> instance is closed, calling the following |
| methods is not allowed: |
| <ul> |
| <li>methods of this <code>ValidatorFactory</code> instance</li> |
| <li>methods of <a href="../../jakarta/validation/Validator.html" title="interface in jakarta.validation"><code>Validator</code></a> instances created by this |
| <code>ValidatorFactory</code></li> |
| </ul></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</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/ValidatorContext.html" title="interface in jakarta.validation"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/validation/ValidatorFactory.html" target="_top">Frames</a></li> |
| <li><a href="ValidatorFactory.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> |
