blob: fc4d3be989361a36169fffc28782c53cc0796405 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>Configuration</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="Configuration";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":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/ClockProvider.html" title="interface in jakarta.validation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../jakarta/validation/Constraint.html" title="annotation in jakarta.validation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?jakarta/validation/Configuration.html" target="_top">Frames</a></li>
<li><a href="Configuration.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 Configuration" class="title">Interface Configuration&lt;T extends Configuration&lt;T&gt;&gt;</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>T</code> - the type of a provider-specific specialization of this contract</dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Configuration&lt;T extends Configuration&lt;T&gt;&gt;</span></pre>
<div class="block">Receives configuration information, selects the appropriate
Jakarta Bean Validation provider and builds the appropriate <a href="../../jakarta/validation/ValidatorFactory.html" title="interface in jakarta.validation"><code>ValidatorFactory</code></a>.
<p>
Usage:
<pre>
//provided by one of the Validation bootstrap methods
Configuration&lt;?&gt; configuration =
ValidatorFactory = configuration
.messageInterpolator( new CustomMessageInterpolator() )
.buildValidatorFactory();
</pre>
<p>
By default, the configuration information is retrieved from
<code>META-INF/validation.xml</code>.
It is possible to override the configuration retrieved from the XML file
by using one or more of the <code>Configuration</code> methods.
<p>
The <a href="../../jakarta/validation/ValidationProviderResolver.html" title="interface in jakarta.validation"><code>ValidationProviderResolver</code></a> is specified at configuration time
(see <a href="../../jakarta/validation/spi/ValidationProvider.html" title="interface in jakarta.validation.spi"><code>ValidationProvider</code></a>).
If none is explicitly requested, the default <code>ValidationProviderResolver</code> is used.
<p>
The provider is selected in the following way:
<ul>
<li>if a specific provider is requested programmatically using
<a href="../../jakarta/validation/Validation.html#byProvider-java.lang.Class-"><code>Validation.byProvider(Class)</code></a>, find the first provider implementing
the provider class requested and use it</li>
<li>if a specific provider is requested in <code>META-INF/validation.xml</code>,
find the first provider implementing the provider class requested and use it</li>
<li>otherwise, use the first provider returned by the
<code>ValidationProviderResolver</code></li>
</ul>
<p>
Implementations are not meant to be thread-safe.</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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><a href="../../jakarta/validation/Configuration.html" title="type parameter in Configuration">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/validation/Configuration.html#addMapping-java.io.InputStream-">addMapping</a></span>(java.io.InputStream&nbsp;stream)</code>
<div class="block">Add a stream describing constraint mapping in the Jakarta Bean Validation XML
format.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../jakarta/validation/Configuration.html" title="type parameter in Configuration">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/validation/Configuration.html#addProperty-java.lang.String-java.lang.String-">addProperty</a></span>(java.lang.String&nbsp;name,
java.lang.String&nbsp;value)</code>
<div class="block">Adds a provider specific property.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../jakarta/validation/Configuration.html" title="type parameter in Configuration">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/validation/Configuration.html#addValueExtractor-jakarta.validation.valueextraction.ValueExtractor-">addValueExtractor</a></span>(<a href="../../jakarta/validation/valueextraction/ValueExtractor.html" title="interface in jakarta.validation.valueextraction">ValueExtractor</a>&lt;?&gt;&nbsp;extractor)</code>
<div class="block">Adds a value extractor.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../jakarta/validation/ValidatorFactory.html" title="interface in jakarta.validation">ValidatorFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/validation/Configuration.html#buildValidatorFactory--">buildValidatorFactory</a></span>()</code>
<div class="block">Build a <a href="../../jakarta/validation/ValidatorFactory.html" title="interface in jakarta.validation"><code>ValidatorFactory</code></a> implementation.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../jakarta/validation/Configuration.html" title="type parameter in Configuration">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/validation/Configuration.html#clockProvider-jakarta.validation.ClockProvider-">clockProvider</a></span>(<a href="../../jakarta/validation/ClockProvider.html" title="interface in jakarta.validation">ClockProvider</a>&nbsp;clockProvider)</code>
<div class="block">Defines the clock provider.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../jakarta/validation/Configuration.html" title="type parameter in Configuration">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/validation/Configuration.html#constraintValidatorFactory-jakarta.validation.ConstraintValidatorFactory-">constraintValidatorFactory</a></span>(<a href="../../jakarta/validation/ConstraintValidatorFactory.html" title="interface in jakarta.validation">ConstraintValidatorFactory</a>&nbsp;constraintValidatorFactory)</code>
<div class="block">Defines the constraint validator factory.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../jakarta/validation/BootstrapConfiguration.html" title="interface in jakarta.validation">BootstrapConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/validation/Configuration.html#getBootstrapConfiguration--">getBootstrapConfiguration</a></span>()</code>
<div class="block">Returns configuration information stored in the <code>META-INF/validation.xml</code> file.</div>
</td>
</tr>
<tr id="i7" 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/Configuration.html#getDefaultClockProvider--">getDefaultClockProvider</a></span>()</code>
<div class="block">Returns an implementation of the <a href="../../jakarta/validation/ClockProvider.html" title="interface in jakarta.validation"><code>ClockProvider</code></a>
interface following the default <code>ClockProvider</code>
defined in the specification:
returns a clock representing the current system time and default time
zone.
</div>
</td>
</tr>
<tr id="i8" 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/Configuration.html#getDefaultConstraintValidatorFactory--">getDefaultConstraintValidatorFactory</a></span>()</code>
<div class="block">Returns an implementation of the <a href="../../jakarta/validation/ConstraintValidatorFactory.html" title="interface in jakarta.validation"><code>ConstraintValidatorFactory</code></a> interface
following the default <code>ConstraintValidatorFactory</code> defined in the
specification:
uses the public no-arg constructor of the <a href="../../jakarta/validation/ConstraintValidator.html" title="interface in jakarta.validation"><code>ConstraintValidator</code></a>
</div>
</td>
</tr>
<tr id="i9" 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/Configuration.html#getDefaultMessageInterpolator--">getDefaultMessageInterpolator</a></span>()</code>
<div class="block">Returns an implementation of the <a href="../../jakarta/validation/MessageInterpolator.html" title="interface in jakarta.validation"><code>MessageInterpolator</code></a> interface
following the default <code>MessageInterpolator</code> defined in the
specification:
use the <code>ValidationMessages</code> resource bundle to load keys
use <code>Locale.getDefault()</code>
</div>
</td>
</tr>
<tr id="i10" 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/Configuration.html#getDefaultParameterNameProvider--">getDefaultParameterNameProvider</a></span>()</code>
<div class="block">Returns an implementation of the <a href="../../jakarta/validation/ParameterNameProvider.html" title="interface in jakarta.validation"><code>ParameterNameProvider</code></a>
interface following the default <code>ParameterNameProvider</code>
defined in the specification:
returns the actual parameter names as provided in the validated
executable’s definition, if the class file of the executable contains
parameter name information
otherwise returns names in the form <code>arg&amp;lt;PARAMETER_INDEX&amp;gt;</code>,
where <code>PARAMETER_INDEX</code> starts at 0 for the first parameter,
e.g.</div>
</td>
</tr>
<tr id="i11" 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/Configuration.html#getDefaultTraversableResolver--">getDefaultTraversableResolver</a></span>()</code>
<div class="block">Returns an implementation of the <a href="../../jakarta/validation/TraversableResolver.html" title="interface in jakarta.validation"><code>TraversableResolver</code></a> interface
following the default <code>TraversableResolver</code> defined in the
specification:
if Java Persistence is available in the runtime environment,
a property is considered reachable if Java Persistence considers
the property as loaded
if Java Persistence is not available in the runtime environment,
all properties are considered reachable
all properties are considered cascadable.
</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../jakarta/validation/Configuration.html" title="type parameter in Configuration">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/validation/Configuration.html#ignoreXmlConfiguration--">ignoreXmlConfiguration</a></span>()</code>
<div class="block">Ignores data from the <code>META-INF/validation.xml</code> file if this
method is called.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../jakarta/validation/Configuration.html" title="type parameter in Configuration">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/validation/Configuration.html#messageInterpolator-jakarta.validation.MessageInterpolator-">messageInterpolator</a></span>(<a href="../../jakarta/validation/MessageInterpolator.html" title="interface in jakarta.validation">MessageInterpolator</a>&nbsp;interpolator)</code>
<div class="block">Defines the message interpolator used.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../../jakarta/validation/Configuration.html" title="type parameter in Configuration">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/validation/Configuration.html#parameterNameProvider-jakarta.validation.ParameterNameProvider-">parameterNameProvider</a></span>(<a href="../../jakarta/validation/ParameterNameProvider.html" title="interface in jakarta.validation">ParameterNameProvider</a>&nbsp;parameterNameProvider)</code>
<div class="block">Defines the parameter name provider.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../jakarta/validation/Configuration.html" title="type parameter in Configuration">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/validation/Configuration.html#traversableResolver-jakarta.validation.TraversableResolver-">traversableResolver</a></span>(<a href="../../jakarta/validation/TraversableResolver.html" title="interface in jakarta.validation">TraversableResolver</a>&nbsp;resolver)</code>
<div class="block">Defines the traversable resolver used.</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="ignoreXmlConfiguration--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ignoreXmlConfiguration</h4>
<pre><a href="../../jakarta/validation/Configuration.html" title="type parameter in Configuration">T</a>&nbsp;ignoreXmlConfiguration()</pre>
<div class="block">Ignores data from the <code>META-INF/validation.xml</code> file if this
method is called.
<p>
This method is typically useful for containers that parse
<code>META-INF/validation.xml</code> themselves and pass the information
via the <code>Configuration</code> methods.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> following the chaining method pattern.</dd>
</dl>
</li>
</ul>
<a name="messageInterpolator-jakarta.validation.MessageInterpolator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>messageInterpolator</h4>
<pre><a href="../../jakarta/validation/Configuration.html" title="type parameter in Configuration">T</a>&nbsp;messageInterpolator(<a href="../../jakarta/validation/MessageInterpolator.html" title="interface in jakarta.validation">MessageInterpolator</a>&nbsp;interpolator)</pre>
<div class="block">Defines the message interpolator used. Has priority over the configuration
based message interpolator.
<p>
If <code>null</code> is passed, the default message interpolator is used
(defined in XML or the specification default).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>interpolator</code> - message interpolator implementation</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> following the chaining method pattern</dd>
</dl>
</li>
</ul>
<a name="traversableResolver-jakarta.validation.TraversableResolver-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>traversableResolver</h4>
<pre><a href="../../jakarta/validation/Configuration.html" title="type parameter in Configuration">T</a>&nbsp;traversableResolver(<a href="../../jakarta/validation/TraversableResolver.html" title="interface in jakarta.validation">TraversableResolver</a>&nbsp;resolver)</pre>
<div class="block">Defines the traversable resolver used. Has priority over the configuration
based traversable resolver.
<p>
If <code>null</code> is passed, the default traversable resolver is used
(defined in XML or the specification default).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>resolver</code> - traversable resolver implementation</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> following the chaining method pattern</dd>
</dl>
</li>
</ul>
<a name="constraintValidatorFactory-jakarta.validation.ConstraintValidatorFactory-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>constraintValidatorFactory</h4>
<pre><a href="../../jakarta/validation/Configuration.html" title="type parameter in Configuration">T</a>&nbsp;constraintValidatorFactory(<a href="../../jakarta/validation/ConstraintValidatorFactory.html" title="interface in jakarta.validation">ConstraintValidatorFactory</a>&nbsp;constraintValidatorFactory)</pre>
<div class="block">Defines the constraint validator factory. Has priority over the configuration
based constraint factory.
<p>
If <code>null</code> is passed, the default constraint validator factory is used
(defined in XML or the specification default).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>constraintValidatorFactory</code> - constraint factory implementation</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> following the chaining method pattern</dd>
</dl>
</li>
</ul>
<a name="parameterNameProvider-jakarta.validation.ParameterNameProvider-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parameterNameProvider</h4>
<pre><a href="../../jakarta/validation/Configuration.html" title="type parameter in Configuration">T</a>&nbsp;parameterNameProvider(<a href="../../jakarta/validation/ParameterNameProvider.html" title="interface in jakarta.validation">ParameterNameProvider</a>&nbsp;parameterNameProvider)</pre>
<div class="block">Defines the parameter name provider. Has priority over the configuration
based provider.
<p>
If <code>null</code> is passed, the default parameter name provider is used
(defined in XML or the specification default).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parameterNameProvider</code> - parameter name provider implementation</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> following the chaining method pattern.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a name="clockProvider-jakarta.validation.ClockProvider-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clockProvider</h4>
<pre><a href="../../jakarta/validation/Configuration.html" title="type parameter in Configuration">T</a>&nbsp;clockProvider(<a href="../../jakarta/validation/ClockProvider.html" title="interface in jakarta.validation">ClockProvider</a>&nbsp;clockProvider)</pre>
<div class="block">Defines the clock provider. Has priority over the configuration
based provider.
<p>
If <code>null</code> is passed, the default clock provider is used
(defined in XML or the specification default).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>clockProvider</code> - clock provider implementation</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> following the chaining method pattern.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="addValueExtractor-jakarta.validation.valueextraction.ValueExtractor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addValueExtractor</h4>
<pre><a href="../../jakarta/validation/Configuration.html" title="type parameter in Configuration">T</a>&nbsp;addValueExtractor(<a href="../../jakarta/validation/valueextraction/ValueExtractor.html" title="interface in jakarta.validation.valueextraction">ValueExtractor</a>&lt;?&gt;&nbsp;extractor)</pre>
<div class="block">Adds a value extractor. Has priority over any extractor for the same
type and type parameter detected through the service loader or given in
the XML configuration.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>extractor</code> - value extractor implementation</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> following the chaining method pattern.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../jakarta/validation/valueextraction/ValueExtractorDeclarationException.html" title="class in jakarta.validation.valueextraction">ValueExtractorDeclarationException</a></code> - if more than one extractor for
the same type and type parameter is added</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="addMapping-java.io.InputStream-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addMapping</h4>
<pre><a href="../../jakarta/validation/Configuration.html" title="type parameter in Configuration">T</a>&nbsp;addMapping(java.io.InputStream&nbsp;stream)</pre>
<div class="block">Add a stream describing constraint mapping in the Jakarta Bean Validation XML
format.
<p>
The stream should be closed by the client API after the
<a href="../../jakarta/validation/ValidatorFactory.html" title="interface in jakarta.validation"><code>ValidatorFactory</code></a> has been built. The Jakarta Bean Validation provider
must not close the stream.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stream</code> - XML mapping stream; the given stream should support the
mark/reset contract (see <code>InputStream.markSupported()</code>);
if it doesn't, it will be wrapped into a stream supporting the
mark/reset contract by the Jakarta Bean Validation provider</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> following the chaining method pattern</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>stream</code> is null</dd>
</dl>
</li>
</ul>
<a name="addProperty-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addProperty</h4>
<pre><a href="../../jakarta/validation/Configuration.html" title="type parameter in Configuration">T</a>&nbsp;addProperty(java.lang.String&nbsp;name,
java.lang.String&nbsp;value)</pre>
<div class="block">Adds a provider specific property. This property is equivalent to
XML configuration properties.
If the underlying provider does not know how to handle the property,
it must silently ignore it.
<p>
Note: Using this non type-safe method is generally not recommended.
<p>
It is more appropriate to use, if available, the type-safe equivalent provided
by a specific provider via its <a href="../../jakarta/validation/Configuration.html" title="interface in jakarta.validation"><code>Configuration</code></a> subclass.
<pre>
ValidatorFactory factory = Validation.byProvider(ACMEProvider.class)
.configure()
.providerSpecificProperty(ACMEState.FAST)
.buildValidatorFactory();
</pre>
This method is typically used by containers parsing <code>META-INF/validation.xml</code>
themselves and injecting the state to the <code>Configuration</code> object.
<p>
If a property with a given name is defined both via this method and in the
XML configuration, the value set programmatically has priority.
<p>
If <code>null</code> is passed as a value, the value defined in XML is used. If no value
is defined in XML, the property is considered unset.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - property name</dd>
<dd><code>value</code> - property value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> following the chaining method pattern</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>name</code> is null</dd>
</dl>
</li>
</ul>
<a name="getDefaultMessageInterpolator--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultMessageInterpolator</h4>
<pre><a href="../../jakarta/validation/MessageInterpolator.html" title="interface in jakarta.validation">MessageInterpolator</a>&nbsp;getDefaultMessageInterpolator()</pre>
<div class="block">Returns an implementation of the <a href="../../jakarta/validation/MessageInterpolator.html" title="interface in jakarta.validation"><code>MessageInterpolator</code></a> interface
following the default <code>MessageInterpolator</code> defined in the
specification:
<ul>
<li>use the <code>ValidationMessages</code> resource bundle to load keys</li>
<li>use <code>Locale.getDefault()</code></li>
</ul></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>default <code>MessageInterpolator</code> implementation compliant with the
specification</dd>
</dl>
</li>
</ul>
<a name="getDefaultTraversableResolver--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultTraversableResolver</h4>
<pre><a href="../../jakarta/validation/TraversableResolver.html" title="interface in jakarta.validation">TraversableResolver</a>&nbsp;getDefaultTraversableResolver()</pre>
<div class="block">Returns an implementation of the <a href="../../jakarta/validation/TraversableResolver.html" title="interface in jakarta.validation"><code>TraversableResolver</code></a> interface
following the default <code>TraversableResolver</code> defined in the
specification:
<ul>
<li>if Java Persistence is available in the runtime environment,
a property is considered reachable if Java Persistence considers
the property as loaded</li>
<li>if Java Persistence is not available in the runtime environment,
all properties are considered reachable</li>
<li>all properties are considered cascadable.</li>
</ul></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>default <code>TraversableResolver</code> implementation compliant with the
specification</dd>
</dl>
</li>
</ul>
<a name="getDefaultConstraintValidatorFactory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultConstraintValidatorFactory</h4>
<pre><a href="../../jakarta/validation/ConstraintValidatorFactory.html" title="interface in jakarta.validation">ConstraintValidatorFactory</a>&nbsp;getDefaultConstraintValidatorFactory()</pre>
<div class="block">Returns an implementation of the <a href="../../jakarta/validation/ConstraintValidatorFactory.html" title="interface in jakarta.validation"><code>ConstraintValidatorFactory</code></a> interface
following the default <code>ConstraintValidatorFactory</code> defined in the
specification:
<ul>
<li>uses the public no-arg constructor of the <a href="../../jakarta/validation/ConstraintValidator.html" title="interface in jakarta.validation"><code>ConstraintValidator</code></a></li>
</ul></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>default <code>ConstraintValidatorFactory</code> implementation compliant with the
specification</dd>
</dl>
</li>
</ul>
<a name="getDefaultParameterNameProvider--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultParameterNameProvider</h4>
<pre><a href="../../jakarta/validation/ParameterNameProvider.html" title="interface in jakarta.validation">ParameterNameProvider</a>&nbsp;getDefaultParameterNameProvider()</pre>
<div class="block">Returns an implementation of the <a href="../../jakarta/validation/ParameterNameProvider.html" title="interface in jakarta.validation"><code>ParameterNameProvider</code></a>
interface following the default <code>ParameterNameProvider</code>
defined in the specification:
<ul>
<li>returns the actual parameter names as provided in the validated
executable’s definition, if the class file of the executable contains
parameter name information</li>
<li>
otherwise returns names in the form <code>arg&amp;lt;PARAMETER_INDEX&amp;gt;</code>,
where <code>PARAMETER_INDEX</code> starts at 0 for the first parameter,
e.g. <code>arg0</code>, <code>arg1</code> etc.</li>
</ul></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>default <code>ParameterNameProvider</code> implementation compliant with
the specification</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a name="getDefaultClockProvider--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultClockProvider</h4>
<pre><a href="../../jakarta/validation/ClockProvider.html" title="interface in jakarta.validation">ClockProvider</a>&nbsp;getDefaultClockProvider()</pre>
<div class="block">Returns an implementation of the <a href="../../jakarta/validation/ClockProvider.html" title="interface in jakarta.validation"><code>ClockProvider</code></a>
interface following the default <code>ClockProvider</code>
defined in the specification:
<ul>
<li>returns a clock representing the current system time and default time
zone.</li>
</ul></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>default <code>ClockProvider</code> implementation compliant with
the specification</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="getBootstrapConfiguration--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBootstrapConfiguration</h4>
<pre><a href="../../jakarta/validation/BootstrapConfiguration.html" title="interface in jakarta.validation">BootstrapConfiguration</a>&nbsp;getBootstrapConfiguration()</pre>
<div class="block">Returns configuration information stored in the <code>META-INF/validation.xml</code> file.
<p>
<b>Note</b>:
<br>
Implementations are encouraged to lazily build this object to delay parsing.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>returns an instance of <a href="../../jakarta/validation/BootstrapConfiguration.html" title="interface in jakarta.validation"><code>BootstrapConfiguration</code></a>; this method never
returns <code>null</code>; if there is no <code>META-INF/validation.xml</code> the
different getters of the returned instance will return <code>null</code>
respectively an empty set or map</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a name="buildValidatorFactory--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>buildValidatorFactory</h4>
<pre><a href="../../jakarta/validation/ValidatorFactory.html" title="interface in jakarta.validation">ValidatorFactory</a>&nbsp;buildValidatorFactory()</pre>
<div class="block">Build a <a href="../../jakarta/validation/ValidatorFactory.html" title="interface in jakarta.validation"><code>ValidatorFactory</code></a> implementation.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>ValidatorFactory</code></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 <code>ValidatorFactory</code> cannot be built</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/ClockProvider.html" title="interface in jakarta.validation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../jakarta/validation/Constraint.html" title="annotation in jakarta.validation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?jakarta/validation/Configuration.html" target="_top">Frames</a></li>
<li><a href="Configuration.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>