Google Git
Sign in
apache / tomee-site-pub / 5029b2533c3906b5c1f8300fff30ee925acf2c30 / . / jakartaee-10.0 / javadoc / jakarta / validation / ConstraintValidatorContext.ConstraintViolationBuilder.NodeContextBuilder.html
blob: 50f6eb1e44879cde63fbbfa6ee71615d7e7219ee [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>ConstraintValidatorContext.ConstraintViolationBuilder.NodeContextBuilder</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="ConstraintValidatorContext.ConstraintViolationBuilder.NodeContextBuilder";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":38,"i4":6,"i5":6,"i6":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated 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/ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderDefinedContext.html" title="interface in jakarta.validation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../jakarta/validation/ConstraintValidatorFactory.html" title="interface in jakarta.validation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?jakarta/validation/ConstraintValidatorContext.ConstraintViolationBuilder.NodeContextBuilder.html" target="_top">Frames</a></li>
<li><a href="ConstraintValidatorContext.ConstraintViolationBuilder.NodeContextBuilder.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 ConstraintValidatorContext.ConstraintViolationBuilder.NodeContextBuilder" class="title">Interface ConstraintValidatorContext.ConstraintViolationBuilder.NodeContextBuilder</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing interface:</dt>
<dd><a href="../../jakarta/validation/ConstraintValidatorContext.ConstraintViolationBuilder.html" title="interface in jakarta.validation">ConstraintValidatorContext.ConstraintViolationBuilder</a></dd>
</dl>
<hr>
<br>
<pre>public static interface <span class="typeNameLabel">ConstraintValidatorContext.ConstraintViolationBuilder.NodeContextBuilder</span></pre>
<div class="block">Represents refinement choices for a node which is
in an iterable, e.g. array, <code>Iterable</code> or <code>Map</code>.
<p>
If the iterable is an indexed collection or a map,
the index or the key should be set.
<p>
The node is not necessarily a leaf node (i.e. subnodes can
be added).</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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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/ConstraintValidatorContext.ConstraintViolationBuilder.LeafNodeBuilderCustomizableContext.html" title="interface in jakarta.validation">ConstraintValidatorContext.ConstraintViolationBuilder.LeafNodeBuilderCustomizableContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/validation/ConstraintValidatorContext.ConstraintViolationBuilder.NodeContextBuilder.html#addBeanNode--">addBeanNode</a></span>()</code>
<div class="block">Adds a bean node (class-level) to the path the <a href="../../jakarta/validation/ConstraintViolation.html" title="interface in jakarta.validation"><code>ConstraintViolation</code></a>
will be associated to.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../jakarta/validation/ConstraintValidatorContext.html" title="interface in jakarta.validation">ConstraintValidatorContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/validation/ConstraintValidatorContext.ConstraintViolationBuilder.NodeContextBuilder.html#addConstraintViolation--">addConstraintViolation</a></span>()</code>
<div class="block">Adds the new <a href="../../jakarta/validation/ConstraintViolation.html" title="interface in jakarta.validation"><code>ConstraintViolation</code></a> to be generated if the
constraint validator mark the value as invalid.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../jakarta/validation/ConstraintValidatorContext.ConstraintViolationBuilder.ContainerElementNodeBuilderCustomizableContext.html" title="interface in jakarta.validation">ConstraintValidatorContext.ConstraintViolationBuilder.ContainerElementNodeBuilderCustomizableContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/validation/ConstraintValidatorContext.ConstraintViolationBuilder.NodeContextBuilder.html#addContainerElementNode-java.lang.String-java.lang.Class-java.lang.Integer-">addContainerElementNode</a></span>(java.lang.String&nbsp;name,
java.lang.Class&lt;?&gt;&nbsp;containerType,
java.lang.Integer&nbsp;typeArgumentIndex)</code>
<div class="block">Adds a container element node to the path the <a href="../../jakarta/validation/ConstraintViolation.html" title="interface in jakarta.validation"><code>ConstraintViolation</code></a>
will be associated to.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../jakarta/validation/ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderCustomizableContext.html" title="interface in jakarta.validation">ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderCustomizableContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/validation/ConstraintValidatorContext.ConstraintViolationBuilder.NodeContextBuilder.html#addNode-java.lang.String-">addNode</a></span>(java.lang.String&nbsp;name)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">since 1.1 - replaced by <a href="../../jakarta/validation/ConstraintValidatorContext.ConstraintViolationBuilder.NodeContextBuilder.html#addPropertyNode-java.lang.String-"><code>addPropertyNode(String)</code></a>
and <a href="../../jakarta/validation/ConstraintValidatorContext.ConstraintViolationBuilder.NodeContextBuilder.html#addBeanNode--"><code>addBeanNode()</code></a></span></div>
</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../jakarta/validation/ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderCustomizableContext.html" title="interface in jakarta.validation">ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderCustomizableContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/validation/ConstraintValidatorContext.ConstraintViolationBuilder.NodeContextBuilder.html#addPropertyNode-java.lang.String-">addPropertyNode</a></span>(java.lang.String&nbsp;name)</code>
<div class="block">Adds a property node to the path the <a href="../../jakarta/validation/ConstraintViolation.html" title="interface in jakarta.validation"><code>ConstraintViolation</code></a>
will be associated to.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../jakarta/validation/ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderDefinedContext.html" title="interface in jakarta.validation">ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderDefinedContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/validation/ConstraintValidatorContext.ConstraintViolationBuilder.NodeContextBuilder.html#atIndex-java.lang.Integer-">atIndex</a></span>(java.lang.Integer&nbsp;index)</code>
<div class="block">Defines the index the object is into the <code>List</code> or array.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../jakarta/validation/ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderDefinedContext.html" title="interface in jakarta.validation">ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderDefinedContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/validation/ConstraintValidatorContext.ConstraintViolationBuilder.NodeContextBuilder.html#atKey-java.lang.Object-">atKey</a></span>(java.lang.Object&nbsp;key)</code>
<div class="block">Defines the key the object is into the <code>Map</code>.</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="atKey-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>atKey</h4>
<pre><a href="../../jakarta/validation/ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderDefinedContext.html" title="interface in jakarta.validation">ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderDefinedContext</a>&nbsp;atKey(java.lang.Object&nbsp;key)</pre>
<div class="block">Defines the key the object is into the <code>Map</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - map key</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a builder representing the current node</dd>
</dl>
</li>
</ul>
<a name="atIndex-java.lang.Integer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>atIndex</h4>
<pre><a href="../../jakarta/validation/ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderDefinedContext.html" title="interface in jakarta.validation">ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderDefinedContext</a>&nbsp;atIndex(java.lang.Integer&nbsp;index)</pre>
<div class="block">Defines the index the object is into the <code>List</code> or array.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - index</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a builder representing the current node</dd>
</dl>
</li>
</ul>
<a name="addNode-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addNode</h4>
<pre><a href="../../jakarta/validation/ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderCustomizableContext.html" title="interface in jakarta.validation">ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderCustomizableContext</a>&nbsp;addNode(java.lang.String&nbsp;name)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">since 1.1 - replaced by <a href="../../jakarta/validation/ConstraintValidatorContext.ConstraintViolationBuilder.NodeContextBuilder.html#addPropertyNode-java.lang.String-"><code>addPropertyNode(String)</code></a>
and <a href="../../jakarta/validation/ConstraintValidatorContext.ConstraintViolationBuilder.NodeContextBuilder.html#addBeanNode--"><code>addBeanNode()</code></a></span></div>
<div class="block">Adds a node to the path the <code>ConstraintViolation</code> will be associated to.
<code>name</code> describes a single property. In particular,
dot (.) is not allowed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - property name</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a builder representing node <code>name</code></dd>
</dl>
</li>
</ul>
<a name="addPropertyNode-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPropertyNode</h4>
<pre><a href="../../jakarta/validation/ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderCustomizableContext.html" title="interface in jakarta.validation">ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderCustomizableContext</a>&nbsp;addPropertyNode(java.lang.String&nbsp;name)</pre>
<div class="block">Adds a property node to the path the <a href="../../jakarta/validation/ConstraintViolation.html" title="interface in jakarta.validation"><code>ConstraintViolation</code></a>
will be associated to.
<code>name</code> describes a single property. In particular,
dot (.) is not allowed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - property name</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a builder representing node <code>name</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the name is null</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a name="addBeanNode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addBeanNode</h4>
<pre><a href="../../jakarta/validation/ConstraintValidatorContext.ConstraintViolationBuilder.LeafNodeBuilderCustomizableContext.html" title="interface in jakarta.validation">ConstraintValidatorContext.ConstraintViolationBuilder.LeafNodeBuilderCustomizableContext</a>&nbsp;addBeanNode()</pre>
<div class="block">Adds a bean node (class-level) to the path the <a href="../../jakarta/validation/ConstraintViolation.html" title="interface in jakarta.validation"><code>ConstraintViolation</code></a>
will be associated to.
<p>
Note that bean nodes are always leaf nodes.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a builder representing the bean node</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a name="addContainerElementNode-java.lang.String-java.lang.Class-java.lang.Integer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addContainerElementNode</h4>
<pre><a href="../../jakarta/validation/ConstraintValidatorContext.ConstraintViolationBuilder.ContainerElementNodeBuilderCustomizableContext.html" title="interface in jakarta.validation">ConstraintValidatorContext.ConstraintViolationBuilder.ContainerElementNodeBuilderCustomizableContext</a>&nbsp;addContainerElementNode(java.lang.String&nbsp;name,
java.lang.Class&lt;?&gt;&nbsp;containerType,
java.lang.Integer&nbsp;typeArgumentIndex)</pre>
<div class="block">Adds a container element node to the path the <a href="../../jakarta/validation/ConstraintViolation.html" title="interface in jakarta.validation"><code>ConstraintViolation</code></a>
will be associated to.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the node name</dd>
<dd><code>containerType</code> - the type of the container</dd>
<dd><code>typeArgumentIndex</code> - the index of the type argument</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a builder representing the container element node</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the index is not valid</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="addConstraintViolation--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>addConstraintViolation</h4>
<pre><a href="../../jakarta/validation/ConstraintValidatorContext.html" title="interface in jakarta.validation">ConstraintValidatorContext</a>&nbsp;addConstraintViolation()</pre>
<div class="block">Adds the new <a href="../../jakarta/validation/ConstraintViolation.html" title="interface in jakarta.validation"><code>ConstraintViolation</code></a> to be generated if the
constraint validator mark the value as invalid.
<p>
Methods of the <code>ConstraintViolationBuilder</code> instance this object
comes from and the constraint violation builder nested
objects throw <code>IllegalStateException</code> after this call.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>ConstraintValidatorContext</code> instance the
<code>ConstraintViolationBuilder</code> comes from</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/ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderDefinedContext.html" title="interface in jakarta.validation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../jakarta/validation/ConstraintValidatorFactory.html" title="interface in jakarta.validation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?jakarta/validation/ConstraintValidatorContext.ConstraintViolationBuilder.NodeContextBuilder.html" target="_top">Frames</a></li>
<li><a href="ConstraintValidatorContext.ConstraintViolationBuilder.NodeContextBuilder.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>