Google Git
Sign in
eclipse / gerrit / www.eclipse.org / eclipselink / a1cc95fb3f44a7bf6484ea92c6e82c7359afaff6 / . / api / 3.0 / jakarta / xml / bind / Validator.html
blob: 3fa457bea243efdbeed2874a93a9146fa9475305 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.2) on Wed Apr 22 10:19:16 CDT 2020 -->
<title>Validator (EclipseLink 3.0.0, API Reference)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2020-04-22">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Validator (EclipseLink 3.0.0, API Reference)";
}
}
catch(err) {
}
//-->
var data = {"i0":38,"i1":38,"i2":38,"i3":38,"i4":38,"i5":38};
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";
var pathtoroot = "../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.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 class="aboutLanguage">EclipseLink 3.0.0, API Reference</div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</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 id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">jakarta.xml.bind</a></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><code><a href="../../../org/eclipse/persistence/jaxb/JAXBValidator.html" title="class in org.eclipse.persistence.jaxb">JAXBValidator</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">Validator</span></pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">since JAXB 2.0</div>
</div>
<div class="block">As of JAXB 2.0, this class is deprecated and optional.
<p>
The <code>Validator</code> class is responsible for controlling the validation
of content trees during runtime.
<p>
<a id="validationtypes"></a>
<b>Three Forms of Validation</b><br>
<blockquote>
<dl>
<dt><b>Unmarshal-Time Validation</b></dt>
<dd>This form of validation enables a client application to receive
information about validation errors and warnings detected while
unmarshalling XML data into a Java content tree and is completely
orthogonal to the other types of validation. To enable or disable
it, see the javadoc for
<a href="Unmarshaller.html#setValidating(boolean)"><code>Unmarshaller.setValidating</code></a>.
All JAXB 1.0 Providers are required to support this operation.
</dd>
<dt><b>On-Demand Validation</b></dt>
<dd> This form of validation enables a client application to receive
information about validation errors and warnings detected in the
Java content tree. At any point, client applications can call
the <a href="#validate(java.lang.Object)"><code>Validator.validate</code></a> method
on the Java content tree (or any sub-tree of it). All JAXB 1.0
Providers are required to support this operation.
</dd>
<dt><b>Fail-Fast Validation</b></dt>
<dd> This form of validation enables a client application to receive
immediate feedback about modifications to the Java content tree
that violate type constraints on Java Properties as defined in
the specification. JAXB Providers are not required support
this type of validation. Of the JAXB Providers that do support
this type of validation, some may require you to decide at schema
compile time whether or not a client application will be allowed
to request fail-fast validation at runtime.
</dd>
</dl>
</blockquote>
<p>
The <code>Validator</code> class is responsible for managing On-Demand Validation.
The <code>Unmarshaller</code> class is responsible for managing Unmarshal-Time
Validation during the unmarshal operations. Although there is no formal
method of enabling validation during the marshal operations, the
<code>Marshaller</code> may detect errors, which will be reported to the
<code>ValidationEventHandler</code> registered on it.
<p>
<a id="defaulthandler"></a>
<b>Using the Default EventHandler</b><br>
<blockquote>
If the client application does not set an event handler on their
<code>Validator</code>, <code>Unmarshaller</code>, or <code>Marshaller</code> prior to
calling the validate, unmarshal, or marshal methods, then a default event
handler will receive notification of any errors or warnings encountered.
The default event handler will cause the current operation to halt after
encountering the first error or fatal error (but will attempt to continue
after receiving warnings).
</blockquote>
<p>
<a id="handlingevents"></a>
<b>Handling Validation Events</b><br>
<blockquote>
There are three ways to handle events encountered during the unmarshal,
validate, and marshal operations:
<dl>
<dt>Use the default event handler</dt>
<dd>The default event handler will be used if you do not specify one
via the <code>setEventHandler</code> API's on <code>Validator</code>,
<code>Unmarshaller</code>, or <code>Marshaller</code>.
</dd>
<dt>Implement and register a custom event handler</dt>
<dd>Client applications that require sophisticated event processing
can implement the <code>ValidationEventHandler</code> interface and
register it with the <code>Unmarshaller</code> and/or
<code>Validator</code>.
</dd>
<dt>Use the <a href="util/ValidationEventCollector.html" title="class in jakarta.xml.bind.util"><code>ValidationEventCollector</code></a>
utility</dt>
<dd>For convenience, a specialized event handler is provided that
simply collects any <code>ValidationEvent</code> objects created
during the unmarshal, validate, and marshal operations and
returns them to the client application as a
<code>java.util.Collection</code>.
</dd>
</dl>
</blockquote>
<p>
<b>Validation and Well-Formedness</b><br>
<blockquote>
<p>
Validation events are handled differently depending on how the client
application is configured to process them as described in the previous
section. However, there are certain cases where a JAXB Provider indicates
that it is no longer able to reliably detect and report errors. In these
cases, the JAXB Provider will set the severity of the ValidationEvent to
FATAL_ERROR to indicate that the unmarshal, validate, or marshal operations
should be terminated. The default event handler and
<code>ValidationEventCollector</code> utility class must terminate processing
after being notified of a fatal error. Client applications that supply their
own <code>ValidationEventHandler</code> should also terminate processing after
being notified of a fatal error. If not, unexpected behaviour may occur.
</blockquote>
<p>
<a id="supportedProps"></a>
<b>Supported Properties</b><br>
<blockquote>
<p>
There currently are not any properties required to be supported by all
JAXB Providers on Validator. However, some providers may support
their own set of provider specific properties.
</blockquote></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="JAXBContext.html" title="class in jakarta.xml.bind"><code>JAXBContext</code></a>,
<a href="Unmarshaller.html" title="interface in jakarta.xml.bind"><code>Unmarshaller</code></a>,
<a href="ValidationEventHandler.html" title="interface in jakarta.xml.bind"><code>ValidationEventHandler</code></a>,
<a href="ValidationEvent.html" title="interface in jakarta.xml.bind"><code>ValidationEvent</code></a>,
<a href="util/ValidationEventCollector.html" title="class in jakarta.xml.bind.util"><code>ValidationEventCollector</code></a></dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd><ul><li>Ryan Shoemaker, Sun Microsystems, Inc.</li><li>Kohsuke Kawaguchi, Sun Microsystems, Inc.</li><li>Joe Fialli, Sun Microsystems, Inc.</li></ul></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6, JAXB 1.0</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<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="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="ValidationEventHandler.html" title="interface in jakarta.xml.bind">ValidationEventHandler</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEventHandler()">getEventHandler</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">since JAXB2.0</div>
</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProperty(java.lang.String)">getProperty</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">since JAXB2.0</div>
</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setEventHandler(jakarta.xml.bind.ValidationEventHandler)">setEventHandler</a></span>&#8203;(<a href="ValidationEventHandler.html" title="interface in jakarta.xml.bind">ValidationEventHandler</a>&nbsp;handler)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">since JAXB2.0</div>
</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setProperty(java.lang.String,java.lang.Object)">setProperty</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;value)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">since JAXB2.0</div>
</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#validate(java.lang.Object)">validate</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;subrootObj)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">since JAXB2.0</div>
</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#validateRoot(java.lang.Object)">validateRoot</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;rootObj)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">since JAXB2.0</div>
</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="setEventHandler(jakarta.xml.bind.ValidationEventHandler)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEventHandler</h4>
<pre class="methodSignature">void&nbsp;setEventHandler&#8203;(<a href="ValidationEventHandler.html" title="interface in jakarta.xml.bind">ValidationEventHandler</a>&nbsp;handler)
throws <a href="JAXBException.html" title="class in jakarta.xml.bind">JAXBException</a></pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">since JAXB2.0</div>
</div>
<div class="block">Allow an application to register a validation event handler.
<p>
The validation event handler will be called by the JAXB Provider if any
validation errors are encountered during calls to
<a href="#validate(java.lang.Object)"><code>validate</code></a>. If the client application does not
register a validation event handler before invoking the validate method,
then validation events will be handled by the default event handler which
will terminate the validate operation after the first error or fatal error
is encountered.
<p>
Calling this method with a null parameter will cause the Validator
to revert back to the default default event handler.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>handler</code> - the validation event handler</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="JAXBException.html" title="class in jakarta.xml.bind">JAXBException</a></code> - if an error was encountered while setting the
event handler</dd>
</dl>
</li>
</ul>
<a id="getEventHandler()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEventHandler</h4>
<pre class="methodSignature"><a href="ValidationEventHandler.html" title="interface in jakarta.xml.bind">ValidationEventHandler</a>&nbsp;getEventHandler()
throws <a href="JAXBException.html" title="class in jakarta.xml.bind">JAXBException</a></pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">since JAXB2.0</div>
</div>
<div class="block">Return the current event handler or the default event handler if one
hasn't been set.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current ValidationEventHandler or the default event handler
if it hasn't been set</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="JAXBException.html" title="class in jakarta.xml.bind">JAXBException</a></code> - if an error was encountered while getting the
current event handler</dd>
</dl>
</li>
</ul>
<a id="validate(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validate</h4>
<pre class="methodSignature">boolean&nbsp;validate&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;subrootObj)
throws <a href="JAXBException.html" title="class in jakarta.xml.bind">JAXBException</a></pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">since JAXB2.0</div>
</div>
<div class="block">Validate the Java content tree starting at <code>subrootObj</code>.
<p>
Client applications can use this method to validate Java content trees
on-demand at runtime. This method can be used to validate any arbitrary
subtree of the Java content tree. Global constraint checking <b>will not
</b> be performed as part of this operation (i.e. ID/IDREF constraints).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>subrootObj</code> - the obj to begin validation at</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the subtree rooted at <code>subrootObj</code> is valid, false
otherwise</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="JAXBException.html" title="class in jakarta.xml.bind">JAXBException</a></code> - if any unexpected problem occurs during validation</dd>
<dd><code><a href="ValidationException.html" title="class in jakarta.xml.bind">ValidationException</a></code> - If the <a href="ValidationEventHandler.html" title="interface in jakarta.xml.bind"><code>ValidationEventHandler</code></a>
returns false from its <code>handleEvent</code> method or the
<code>Validator</code> is unable to validate the content tree rooted
at <code>subrootObj</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - If the subrootObj parameter is null</dd>
</dl>
</li>
</ul>
<a id="validateRoot(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validateRoot</h4>
<pre class="methodSignature">boolean&nbsp;validateRoot&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;rootObj)
throws <a href="JAXBException.html" title="class in jakarta.xml.bind">JAXBException</a></pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">since JAXB2.0</div>
</div>
<div class="block">Validate the Java content tree rooted at <code>rootObj</code>.
<p>
Client applications can use this method to validate Java content trees
on-demand at runtime. This method is used to validate an entire Java
content tree. Global constraint checking <b>will</b> be performed as
part of this operation (i.e. ID/IDREF constraints).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rootObj</code> - the root obj to begin validation at</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the tree rooted at <code>rootObj</code> is valid, false
otherwise</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="JAXBException.html" title="class in jakarta.xml.bind">JAXBException</a></code> - if any unexpected problem occurs during validation</dd>
<dd><code><a href="ValidationException.html" title="class in jakarta.xml.bind">ValidationException</a></code> - If the <a href="ValidationEventHandler.html" title="interface in jakarta.xml.bind"><code>ValidationEventHandler</code></a>
returns false from its <code>handleEvent</code> method or the
<code>Validator</code> is unable to validate the content tree rooted
at <code>rootObj</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - If the rootObj parameter is null</dd>
</dl>
</li>
</ul>
<a id="setProperty(java.lang.String,java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProperty</h4>
<pre class="methodSignature">void&nbsp;setProperty&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;value)
throws <a href="PropertyException.html" title="class in jakarta.xml.bind">PropertyException</a></pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">since JAXB2.0</div>
</div>
<div class="block">Set the particular property in the underlying implementation of
<code>Validator</code>. This method can only be used to set one of
the standard JAXB defined properties above or a provider specific
property. Attempting to set an undefined property will result in
a PropertyException being thrown. See <a href="#supportedProps">
Supported Properties</a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the property to be set. This value can either
be specified using one of the constant fields or a user
supplied string.</dd>
<dd><code>value</code> - the value of the property to be set</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="PropertyException.html" title="class in jakarta.xml.bind">PropertyException</a></code> - when there is an error processing the given
property or value</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - If the name parameter is null</dd>
</dl>
</li>
</ul>
<a id="getProperty(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getProperty</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;getProperty&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name)
throws <a href="PropertyException.html" title="class in jakarta.xml.bind">PropertyException</a></pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">since JAXB2.0</div>
</div>
<div class="block">Get the particular property in the underlying implementation of
<code>Validator</code>. This method can only be used to get one of
the standard JAXB defined properties above or a provider specific
property. Attempting to get an undefined property will result in
a PropertyException being thrown. See <a href="#supportedProps">
Supported Properties</a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the property to retrieve</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value of the requested property</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="PropertyException.html" title="class in jakarta.xml.bind">PropertyException</a></code> - when there is an error retrieving the given property or value
property name</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - If the name parameter is null</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.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 class="aboutLanguage">EclipseLink 3.0.0, API Reference</div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2017&#x2013;2020 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p>
</footer>
</body>
</html>