Google Git
Sign in
apache / tomee-site-pub / d5ed758956cd82f74d6a0b2ab8ca241a1a6a7bf4 / . / jakartaee-8.0 / javadoc / javax / validation / ValidatorContext.html
blob: d3faa787d354a42ab5953fb7ab56ff612cf75b9b [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>ValidatorContext</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="ValidatorContext";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":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="../../javax/validation/Validator.html" title="interface in javax.validation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../javax/validation/ValidatorFactory.html" title="interface in javax.validation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?javax/validation/ValidatorContext.html" target="_top">Frames</a></li>
<li><a href="ValidatorContext.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">javax.validation</div>
<h2 title="Interface ValidatorContext" class="title">Interface ValidatorContext</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ValidatorContext</span></pre>
<div class="block">Represents the context that is used to create <a href="../../javax/validation/Validator.html" title="interface in javax.validation"><code>Validator</code></a>
instances.
A client may use methods of the <code>ValidatorContext</code> returned by
<a href="../../javax/validation/ValidatorFactory.html#usingContext--"><code>ValidatorFactory.usingContext()</code></a> to customize
the context used to create <code>Validator</code> instances
(for instance establish different message interpolators or
traversable resolvers).</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="../../javax/validation/ValidatorContext.html" title="interface in javax.validation">ValidatorContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/validation/ValidatorContext.html#addValueExtractor-javax.validation.valueextraction.ValueExtractor-">addValueExtractor</a></span>(<a href="../../javax/validation/valueextraction/ValueExtractor.html" title="interface in javax.validation.valueextraction">ValueExtractor</a>&lt;?&gt;&nbsp;extractor)</code>
<div class="block">Adds a value extractor to be used by the <a href="../../javax/validation/Validator.html" title="interface in javax.validation"><code>Validator</code></a>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../javax/validation/ValidatorContext.html" title="interface in javax.validation">ValidatorContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/validation/ValidatorContext.html#clockProvider-javax.validation.ClockProvider-">clockProvider</a></span>(<a href="../../javax/validation/ClockProvider.html" title="interface in javax.validation">ClockProvider</a>&nbsp;clockProvider)</code>
<div class="block">Defines the <a href="../../javax/validation/ClockProvider.html" title="interface in javax.validation"><code>ClockProvider</code></a> implementation used by the <a href="../../javax/validation/Validator.html" title="interface in javax.validation"><code>Validator</code></a>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../javax/validation/ValidatorContext.html" title="interface in javax.validation">ValidatorContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/validation/ValidatorContext.html#constraintValidatorFactory-javax.validation.ConstraintValidatorFactory-">constraintValidatorFactory</a></span>(<a href="../../javax/validation/ConstraintValidatorFactory.html" title="interface in javax.validation">ConstraintValidatorFactory</a>&nbsp;factory)</code>
<div class="block">Defines the constraint validator factory implementation used by the
<a href="../../javax/validation/Validator.html" title="interface in javax.validation"><code>Validator</code></a>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../javax/validation/Validator.html" title="interface in javax.validation">Validator</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/validation/ValidatorContext.html#getValidator--">getValidator</a></span>()</code>
<div class="block">Returns an initialized <a href="../../javax/validation/Validator.html" title="interface in javax.validation"><code>Validator</code></a> instance respecting the defined state.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../javax/validation/ValidatorContext.html" title="interface in javax.validation">ValidatorContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/validation/ValidatorContext.html#messageInterpolator-javax.validation.MessageInterpolator-">messageInterpolator</a></span>(<a href="../../javax/validation/MessageInterpolator.html" title="interface in javax.validation">MessageInterpolator</a>&nbsp;messageInterpolator)</code>
<div class="block">Defines the message interpolator implementation used by the
<a href="../../javax/validation/Validator.html" title="interface in javax.validation"><code>Validator</code></a>.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../javax/validation/ValidatorContext.html" title="interface in javax.validation">ValidatorContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/validation/ValidatorContext.html#parameterNameProvider-javax.validation.ParameterNameProvider-">parameterNameProvider</a></span>(<a href="../../javax/validation/ParameterNameProvider.html" title="interface in javax.validation">ParameterNameProvider</a>&nbsp;parameterNameProvider)</code>
<div class="block">Defines the parameter name provider implementation used by the
<a href="../../javax/validation/Validator.html" title="interface in javax.validation"><code>Validator</code></a>.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../javax/validation/ValidatorContext.html" title="interface in javax.validation">ValidatorContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/validation/ValidatorContext.html#traversableResolver-javax.validation.TraversableResolver-">traversableResolver</a></span>(<a href="../../javax/validation/TraversableResolver.html" title="interface in javax.validation">TraversableResolver</a>&nbsp;traversableResolver)</code>
<div class="block">Defines the traversable resolver implementation used by the
<a href="../../javax/validation/Validator.html" title="interface in javax.validation"><code>Validator</code></a>.</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="messageInterpolator-javax.validation.MessageInterpolator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>messageInterpolator</h4>
<pre><a href="../../javax/validation/ValidatorContext.html" title="interface in javax.validation">ValidatorContext</a>&nbsp;messageInterpolator(<a href="../../javax/validation/MessageInterpolator.html" title="interface in javax.validation">MessageInterpolator</a>&nbsp;messageInterpolator)</pre>
<div class="block">Defines the message interpolator implementation used by the
<a href="../../javax/validation/Validator.html" title="interface in javax.validation"><code>Validator</code></a>.
<p>
If not set or if <code>null</code> is passed as a parameter,
the message interpolator of the <a href="../../javax/validation/ValidatorFactory.html" title="interface in javax.validation"><code>ValidatorFactory</code></a>
is used.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>messageInterpolator</code> - the <a href="../../javax/validation/MessageInterpolator.html" title="interface in javax.validation"><code>MessageInterpolator</code></a> used by the
<code>Validator</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>self following the chaining method pattern</dd>
</dl>
</li>
</ul>
<a name="traversableResolver-javax.validation.TraversableResolver-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>traversableResolver</h4>
<pre><a href="../../javax/validation/ValidatorContext.html" title="interface in javax.validation">ValidatorContext</a>&nbsp;traversableResolver(<a href="../../javax/validation/TraversableResolver.html" title="interface in javax.validation">TraversableResolver</a>&nbsp;traversableResolver)</pre>
<div class="block">Defines the traversable resolver implementation used by the
<a href="../../javax/validation/Validator.html" title="interface in javax.validation"><code>Validator</code></a>.
<p>
If not set or if <code>null</code> is passed as a parameter,
the traversable resolver of the <a href="../../javax/validation/ValidatorFactory.html" title="interface in javax.validation"><code>ValidatorFactory</code></a> is used.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>traversableResolver</code> - the <code>TraversableResolver</code> used by the
<code>Validator</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>self following the chaining method pattern</dd>
</dl>
</li>
</ul>
<a name="constraintValidatorFactory-javax.validation.ConstraintValidatorFactory-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>constraintValidatorFactory</h4>
<pre><a href="../../javax/validation/ValidatorContext.html" title="interface in javax.validation">ValidatorContext</a>&nbsp;constraintValidatorFactory(<a href="../../javax/validation/ConstraintValidatorFactory.html" title="interface in javax.validation">ConstraintValidatorFactory</a>&nbsp;factory)</pre>
<div class="block">Defines the constraint validator factory implementation used by the
<a href="../../javax/validation/Validator.html" title="interface in javax.validation"><code>Validator</code></a>.
If not set or if <code>null</code> is passed as a parameter,
the constraint validator factory of the <a href="../../javax/validation/ValidatorFactory.html" title="interface in javax.validation"><code>ValidatorFactory</code></a> is used.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>factory</code> - the <a href="../../javax/validation/ConstraintValidatorFactory.html" title="interface in javax.validation"><code>ConstraintValidatorFactory</code></a> used by the <code>Validator</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>self following the chaining method pattern</dd>
</dl>
</li>
</ul>
<a name="parameterNameProvider-javax.validation.ParameterNameProvider-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parameterNameProvider</h4>
<pre><a href="../../javax/validation/ValidatorContext.html" title="interface in javax.validation">ValidatorContext</a>&nbsp;parameterNameProvider(<a href="../../javax/validation/ParameterNameProvider.html" title="interface in javax.validation">ParameterNameProvider</a>&nbsp;parameterNameProvider)</pre>
<div class="block">Defines the parameter name provider implementation used by the
<a href="../../javax/validation/Validator.html" title="interface in javax.validation"><code>Validator</code></a>. If not set or if <code>null</code> is passed as a parameter,
the parameter name provider of the <a href="../../javax/validation/ValidatorFactory.html" title="interface in javax.validation"><code>ValidatorFactory</code></a> is used.</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>self following the chaining method pattern</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a name="clockProvider-javax.validation.ClockProvider-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clockProvider</h4>
<pre><a href="../../javax/validation/ValidatorContext.html" title="interface in javax.validation">ValidatorContext</a>&nbsp;clockProvider(<a href="../../javax/validation/ClockProvider.html" title="interface in javax.validation">ClockProvider</a>&nbsp;clockProvider)</pre>
<div class="block">Defines the <a href="../../javax/validation/ClockProvider.html" title="interface in javax.validation"><code>ClockProvider</code></a> implementation used by the <a href="../../javax/validation/Validator.html" title="interface in javax.validation"><code>Validator</code></a>.
If not set or if <code>null</code> is passed as a parameter,
the clock provider of the <a href="../../javax/validation/ValidatorFactory.html" title="interface in javax.validation"><code>ValidatorFactory</code></a> is used.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>clockProvider</code> - <code>ClockProvider</code> implementation</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>self following the chaining method pattern</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="addValueExtractor-javax.validation.valueextraction.ValueExtractor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addValueExtractor</h4>
<pre><a href="../../javax/validation/ValidatorContext.html" title="interface in javax.validation">ValidatorContext</a>&nbsp;addValueExtractor(<a href="../../javax/validation/valueextraction/ValueExtractor.html" title="interface in javax.validation.valueextraction">ValueExtractor</a>&lt;?&gt;&nbsp;extractor)</pre>
<div class="block">Adds a value extractor to be used by the <a href="../../javax/validation/Validator.html" title="interface in javax.validation"><code>Validator</code></a>. Has
priority over any extractor for the same type and type parameter
detected through the service loader, given in the XML configuration or
configured for the validator factory.</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>self following the chaining method pattern</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../javax/validation/valueextraction/ValueExtractorDeclarationException.html" title="class in javax.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="getValidator--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getValidator</h4>
<pre><a href="../../javax/validation/Validator.html" title="interface in javax.validation">Validator</a>&nbsp;getValidator()</pre>
<div class="block">Returns an initialized <a href="../../javax/validation/Validator.html" title="interface in javax.validation"><code>Validator</code></a> instance respecting the defined state.
<code>Validator</code> instances can be pooled and shared by the implementation.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>contextualized <code>Validator</code></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/Validator.html" title="interface in javax.validation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../javax/validation/ValidatorFactory.html" title="interface in javax.validation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?javax/validation/ValidatorContext.html" target="_top">Frames</a></li>
<li><a href="ValidatorContext.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>