| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>Validation</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="Validation"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete 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/Valid.html" title="annotation in javax.validation"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../javax/validation/ValidationException.html" title="class in javax.validation"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?javax/validation/Validation.html" target="_top">Frames</a></li> |
| <li><a href="Validation.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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="Class Validation" class="title">Class Validation</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>javax.validation.Validation</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">Validation</span> |
| extends java.lang.Object</pre> |
| <div class="block">This class is the entry point for Jakarta Bean Validation. |
| <p> |
| There are three ways to bootstrap it: |
| <ul> |
| <li>The easiest approach is to build the default <a href="../../javax/validation/ValidatorFactory.html" title="interface in javax.validation"><code>ValidatorFactory</code></a>. |
| <pre> |
| ValidatorFactory factory = Validation.buildDefaultValidatorFactory(); |
| </pre> |
| In this case, the default validation provider resolver |
| will be used to locate available providers. |
| <p> |
| The chosen provider is defined as followed: |
| <ul> |
| <li>if the XML configuration defines a provider, this provider is used</li> |
| <li>if the XML configuration does not define a provider or if no XML |
| configuration is present the first provider returned by the |
| <a href="../../javax/validation/ValidationProviderResolver.html" title="interface in javax.validation"><code>ValidationProviderResolver</code></a> instance is used.</li> |
| </ul> |
| </li> |
| <li> |
| The second bootstrap approach allows to choose a custom |
| <code>ValidationProviderResolver</code>. The chosen |
| <a href="../../javax/validation/spi/ValidationProvider.html" title="interface in javax.validation.spi"><code>ValidationProvider</code></a> is then determined in the same way |
| as in the default bootstrapping case (see above). |
| <pre> |
| Configuration<?> configuration = Validation |
| .byDefaultProvider() |
| .providerResolver( new MyResolverStrategy() ) |
| .configure(); |
| ValidatorFactory factory = configuration.buildValidatorFactory(); |
| </pre> |
| </li> |
| <li> |
| The third approach allows you to specify explicitly and in |
| a type safe fashion the expected provider. |
| <p> |
| Optionally you can choose a custom <code>ValidationProviderResolver</code>. |
| <pre> |
| ACMEConfiguration configuration = Validation |
| .byProvider(ACMEProvider.class) |
| .providerResolver( new MyResolverStrategy() ) // optionally set the provider resolver |
| .configure(); |
| ValidatorFactory factory = configuration.buildValidatorFactory(); |
| </pre> |
| </li> |
| </ul> |
| <p> |
| Note: |
| <ul> |
| <li> |
| The <code>ValidatorFactory</code> object built by the bootstrap process should be cached |
| and shared amongst <code>Validator</code> consumers. |
| </li> |
| <li>This class is thread-safe.</li> |
| </ul></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/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></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/deltaspike-fullstack.html">deltaspike-fullstack</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../javax/validation/Validation.html#Validation--">Validation</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== 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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>static <a href="../../javax/validation/ValidatorFactory.html" title="interface in javax.validation">ValidatorFactory</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/validation/Validation.html#buildDefaultValidatorFactory--">buildDefaultValidatorFactory</a></span>()</code> |
| <div class="block">Builds and returns a <a href="../../javax/validation/ValidatorFactory.html" title="interface in javax.validation"><code>ValidatorFactory</code></a> instance based on the |
| default Jakarta Bean Validation provider and following the XML configuration.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../javax/validation/bootstrap/GenericBootstrap.html" title="interface in javax.validation.bootstrap">GenericBootstrap</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/validation/Validation.html#byDefaultProvider--">byDefaultProvider</a></span>()</code> |
| <div class="block">Builds a <a href="../../javax/validation/Configuration.html" title="interface in javax.validation"><code>Configuration</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <T extends <a href="../../javax/validation/Configuration.html" title="interface in javax.validation">Configuration</a><T>,U extends <a href="../../javax/validation/spi/ValidationProvider.html" title="interface in javax.validation.spi">ValidationProvider</a><T>><br><a href="../../javax/validation/bootstrap/ProviderSpecificBootstrap.html" title="interface in javax.validation.bootstrap">ProviderSpecificBootstrap</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/validation/Validation.html#byProvider-java.lang.Class-">byProvider</a></span>(java.lang.Class<U> providerType)</code> |
| <div class="block">Builds a <a href="../../javax/validation/Configuration.html" title="interface in javax.validation"><code>Configuration</code></a> for a particular provider implementation.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="Validation--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Validation</h4> |
| <pre>public Validation()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="buildDefaultValidatorFactory--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildDefaultValidatorFactory</h4> |
| <pre>public static <a href="../../javax/validation/ValidatorFactory.html" title="interface in javax.validation">ValidatorFactory</a> buildDefaultValidatorFactory()</pre> |
| <div class="block">Builds and returns a <a href="../../javax/validation/ValidatorFactory.html" title="interface in javax.validation"><code>ValidatorFactory</code></a> instance based on the |
| default Jakarta Bean Validation provider and following the XML configuration. |
| <p> |
| The provider list is resolved using the default validation provider resolver |
| logic. |
| <p> |
| The code is semantically equivalent to |
| <code>Validation.byDefaultProvider().configure().buildValidatorFactory()</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>ValidatorFactory</code> instance</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/validation/NoProviderFoundException.html" title="class in javax.validation">NoProviderFoundException</a></code> - if no Jakarta Bean Validation provider was found</dd> |
| <dd><code><a href="../../javax/validation/ValidationException.html" title="class in javax.validation">ValidationException</a></code> - if a Jakarta Bean Validation provider was found but the |
| <code>ValidatorFactory</code> cannot be built</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="byDefaultProvider--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>byDefaultProvider</h4> |
| <pre>public static <a href="../../javax/validation/bootstrap/GenericBootstrap.html" title="interface in javax.validation.bootstrap">GenericBootstrap</a> byDefaultProvider()</pre> |
| <div class="block">Builds a <a href="../../javax/validation/Configuration.html" title="interface in javax.validation"><code>Configuration</code></a>. The provider list is resolved |
| using the strategy provided to the bootstrap state. |
| <pre> |
| Configuration<?> configuration = Validation |
| .byDefaultProvider() |
| .providerResolver( new MyResolverStrategy() ) |
| .configure(); |
| ValidatorFactory factory = configuration.buildValidatorFactory(); |
| </pre> |
| The provider can be specified in the XML configuration. If the XML |
| configuration does not exist or if no provider is specified, |
| the first available provider will be returned.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>instance building a generic <code>Configuration</code> |
| compliant with the bootstrap state provided</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="byProvider-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>byProvider</h4> |
| <pre>public static <T extends <a href="../../javax/validation/Configuration.html" title="interface in javax.validation">Configuration</a><T>,U extends <a href="../../javax/validation/spi/ValidationProvider.html" title="interface in javax.validation.spi">ValidationProvider</a><T>> <a href="../../javax/validation/bootstrap/ProviderSpecificBootstrap.html" title="interface in javax.validation.bootstrap">ProviderSpecificBootstrap</a><T> byProvider(java.lang.Class<U> providerType)</pre> |
| <div class="block">Builds a <a href="../../javax/validation/Configuration.html" title="interface in javax.validation"><code>Configuration</code></a> for a particular provider implementation. |
| <p> |
| Optionally overrides the provider resolution strategy used to determine the provider. |
| <p> |
| Used by applications targeting a specific provider programmatically. |
| <pre> |
| ACMEConfiguration configuration = |
| Validation.byProvider(ACMEProvider.class) |
| .providerResolver( new MyResolverStrategy() ) |
| .configure(); |
| </pre>, |
| where <code>ACMEConfiguration</code> is the |
| <code>Configuration</code> sub interface uniquely identifying the |
| ACME Jakarta Bean Validation provider. and <code>ACMEProvider</code> is the |
| <a href="../../javax/validation/spi/ValidationProvider.html" title="interface in javax.validation.spi"><code>ValidationProvider</code></a> implementation of the ACME provider.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the type of the <code>Configuration</code> corresponding to this |
| <code>ValidationProvider</code></dd> |
| <dd><code>U</code> - the type of the <code>ValidationProvider</code> implementation</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>providerType</code> - the <code>ValidationProvider</code> implementation type</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>instance building a provider specific <code>Configuration</code> |
| sub interface implementation</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/Valid.html" title="annotation in javax.validation"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../javax/validation/ValidationException.html" title="class in javax.validation"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?javax/validation/Validation.html" target="_top">Frames</a></li> |
| <li><a href="Validation.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
