blob: 83f85ee68a2e911095f816b79e7a85e301df1628 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (version 1.7.0_79) on Mon Mar 21 21:59:42 CET 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Validator (OpenJPA Parent POM 2.4.1 API)</title>
<meta name="date" content="2016-03-21">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Validator (OpenJPA Parent POM 2.4.1 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="class-use/Validator.html">Use</a></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="../../../../org/apache/openjpa/validation/ValidationUnavailableException.html" title="class in org.apache.openjpa.validation"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/validation/Validator.html" target="_top">Frames</a></li>
<li><a href="Validator.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:&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">org.apache.openjpa.validation</div>
<h2 title="Interface Validator" class="title">Interface Validator</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/openjpa/validation/AbstractValidator.html" title="class in org.apache.openjpa.validation">AbstractValidator</a>, <a href="../../../../org/apache/openjpa/persistence/validation/ValidatorImpl.html" title="class in org.apache.openjpa.persistence.validation">ValidatorImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">Validator</span></pre>
<div class="block">Basic validation interface which defines the contract for
event based validation. Event values are defined in LifeCycleEvent.</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;<a href="../../../../org/apache/openjpa/validation/ValidationException.html" title="class in org.apache.openjpa.validation">ValidationException</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/validation/Validator.html#validate(T,%20int)">validate</a></strong>(T&nbsp;arg0,
int&nbsp;event)</code>
<div class="block">Validates a given instance</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;<a href="../../../../org/apache/openjpa/validation/ValidationException.html" title="class in org.apache.openjpa.validation">ValidationException</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/validation/Validator.html#validateProperty(T,%20java.lang.String,%20int)">validateProperty</a></strong>(T&nbsp;arg0,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;property,
int&nbsp;event)</code>
<div class="block">Validates a property of a given instance</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;<a href="../../../../org/apache/openjpa/validation/ValidationException.html" title="class in org.apache.openjpa.validation">ValidationException</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/validation/Validator.html#validateValue(java.lang.Class,%20java.lang.String,%20java.lang.Object,%20int)">validateValue</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;arg0,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;arg1,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;arg2,
int&nbsp;event)</code>
<div class="block">Validates a value based upon the constraints applied to a given class
attribute.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/validation/Validator.html#validating(T,%20int)">validating</a></strong>(T&nbsp;arg0,
int&nbsp;event)</code>
<div class="block">Method for determining whether validation is active for the given
type and event.</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="validate(java.lang.Object,int)">
<!-- -->
</a><a name="validate(T, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validate</h4>
<pre>&lt;T&gt;&nbsp;<a href="../../../../org/apache/openjpa/validation/ValidationException.html" title="class in org.apache.openjpa.validation">ValidationException</a>&nbsp;validate(T&nbsp;arg0,
int&nbsp;event)</pre>
<div class="block">Validates a given instance</div>
<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - The instance to validate</dd><dt><span class="strong">Parameters:</span></dt><dd><code>arg0</code> - The class, of type T to validate</dd><dd><code>event</code> - The event id</dd>
<dt><span class="strong">Returns:</span></dt><dd>ValidationException if the validator produces one or more
constraint violations.</dd></dl>
</li>
</ul>
<a name="validateProperty(java.lang.Object,java.lang.String,int)">
<!-- -->
</a><a name="validateProperty(T, java.lang.String, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validateProperty</h4>
<pre>&lt;T&gt;&nbsp;<a href="../../../../org/apache/openjpa/validation/ValidationException.html" title="class in org.apache.openjpa.validation">ValidationException</a>&nbsp;validateProperty(T&nbsp;arg0,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;property,
int&nbsp;event)</pre>
<div class="block">Validates a property of a given instance</div>
<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - The instance to validate</dd><dt><span class="strong">Parameters:</span></dt><dd><code>arg0</code> - The class, of type T to validate</dd><dd><code>property</code> - The property to validate</dd><dd><code>event</code> - The event id</dd>
<dt><span class="strong">Returns:</span></dt><dd>ValidationException if the validator produces one or more
constraint violations.</dd></dl>
</li>
</ul>
<a name="validateValue(java.lang.Class, java.lang.String, java.lang.Object, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validateValue</h4>
<pre>&lt;T&gt;&nbsp;<a href="../../../../org/apache/openjpa/validation/ValidationException.html" title="class in org.apache.openjpa.validation">ValidationException</a>&nbsp;validateValue(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;arg0,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;arg1,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;arg2,
int&nbsp;event)</pre>
<div class="block">Validates a value based upon the constraints applied to a given class
attribute.</div>
<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - The instance type to base validation upon</dd><dt><span class="strong">Parameters:</span></dt><dd><code>arg0</code> - The class of type T to validate</dd><dd><code>arg1</code> - The property to validate</dd><dd><code>arg2</code> - The property value to validate</dd><dd><code>event</code> - The event id</dd>
<dt><span class="strong">Returns:</span></dt><dd>ValidationException if the validator produces one or more
constraint violations.</dd></dl>
</li>
</ul>
<a name="validating(java.lang.Object,int)">
<!-- -->
</a><a name="validating(T, int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>validating</h4>
<pre>&lt;T&gt;&nbsp;boolean&nbsp;validating(T&nbsp;arg0,
int&nbsp;event)</pre>
<div class="block">Method for determining whether validation is active for the given
type and event.</div>
<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - </dd><dt><span class="strong">Parameters:</span></dt><dd><code>arg0</code> - Type being validated</dd><dd><code>event</code> - event type</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if validation is active for the specified event</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="class-use/Validator.html">Use</a></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="../../../../org/apache/openjpa/validation/ValidationUnavailableException.html" title="class in org.apache.openjpa.validation"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/validation/Validator.html" target="_top">Frames</a></li>
<li><a href="Validator.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:&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 ======= -->
<p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2016 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>