blob: 20f908e2e4599e70df4b130beb741b327486dbc6 [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>
<!-- Generated by javadoc (1.8.0_252) on Fri Jul 16 09:39:14 UTC 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.eclipse.persistence.oxm (EclipseLink 3.0.2, API Reference)</title>
<meta name="date" content="2021-07-16">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.eclipse.persistence.oxm (EclipseLink 3.0.2, API Reference)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>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.2, API Reference</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/eclipse/persistence/mappings/xdb/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/eclipse/persistence/oxm/annotations/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/eclipse/persistence/oxm/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.eclipse.persistence.oxm</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/eclipse/persistence/oxm/CharacterEscapeHandler.html" title="interface in org.eclipse.persistence.oxm">CharacterEscapeHandler</a></td>
<td class="colLast">
<div class="block">
Provide an interface to allow for custom character escaping behaviour.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/eclipse/persistence/oxm/XMLMarshalListener.html" title="interface in org.eclipse.persistence.oxm">XMLMarshalListener</a></td>
<td class="colLast">
<div class="block">An implementation of XMLMarshalListener can be set on an XMLMarshaller to provide additional
behaviour during marshal operations.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/eclipse/persistence/oxm/XMLNameTransformer.html" title="interface in org.eclipse.persistence.oxm">XMLNameTransformer</a></td>
<td class="colLast">
<div class="block">Interface used when converting from XML to Java names.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/eclipse/persistence/oxm/XMLUnmarshalListener.html" title="interface in org.eclipse.persistence.oxm">XMLUnmarshalListener</a></td>
<td class="colLast">
<div class="block">An implementation of XMLUnmarshalListener can be set on an XMLUnmarshaller to provide additional
behaviour during unmarshal operations.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/eclipse/persistence/oxm/IDResolver.html" title="class in org.eclipse.persistence.oxm">IDResolver</a></td>
<td class="colLast">
<div class="block">
IDResolver can be subclassed to allow customization of the ID/IDREF processing of
XMLUnmarshaller.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/eclipse/persistence/oxm/JSONWithPadding.html" title="class in org.eclipse.persistence.oxm">JSONWithPadding</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">JSONWithPadding is used to hold an Object along with the corresponding callback name
to marshal.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/eclipse/persistence/oxm/NamespacePrefixMapper.html" title="class in org.eclipse.persistence.oxm">NamespacePrefixMapper</a></td>
<td class="colLast">
<div class="block"><b>Purpose</b>:Provides a means to customise the namespace prefixes used while marshalling
An implementation of this class can be set on an instance of XMLMarshaller to allow for
each instance of XMLMarshaller to use different namespace prefixes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/eclipse/persistence/oxm/NamespaceResolver.html" title="class in org.eclipse.persistence.oxm">NamespaceResolver</a></td>
<td class="colLast">
<div class="block"><p >It is common for an XML document to include one or more namespaces.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/eclipse/persistence/oxm/XMLBinder.html" title="class in org.eclipse.persistence.oxm">XMLBinder</a></td>
<td class="colLast">
<div class="block">PUBLIC:</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/eclipse/persistence/oxm/XMLConstants.html" title="class in org.eclipse.persistence.oxm">XMLConstants</a></td>
<td class="colLast">
<div class="block">XMLConstants maintains a list of useful XML constants.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/eclipse/persistence/oxm/XMLContext.html" title="class in org.eclipse.persistence.oxm">XMLContext</a></td>
<td class="colLast">
<div class="block">
An XMLContext is created based on EclipseLink sessions or projects and can then
used to create instances of XMLMarshaller, XMLUnmarshaller and XMLValidator.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/eclipse/persistence/oxm/XMLDescriptor.html" title="class in org.eclipse.persistence.oxm">XMLDescriptor</a></td>
<td class="colLast">
<div class="block">Use an XML project for nontransactional, nonpersistent (in-memory) conversions between Java objects and XML documents.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/eclipse/persistence/oxm/XMLField.html" title="class in org.eclipse.persistence.oxm">XMLField</a></td>
<td class="colLast">
<div class="block">TopLink XML mappings make use of XMLFields based on XPath statements to find the relevant
data in an XML document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/eclipse/persistence/oxm/XMLLogin.html" title="class in org.eclipse.persistence.oxm">XMLLogin</a></td>
<td class="colLast">
<div class="block">In OX, the platform determines which parsing method will be used, DOM vs SAX.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/eclipse/persistence/oxm/XMLMarshaller.html" title="class in org.eclipse.persistence.oxm">XMLMarshaller</a></td>
<td class="colLast">
<div class="block">Class used to marshal object to XML.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/eclipse/persistence/oxm/XMLRoot.html" title="class in org.eclipse.persistence.oxm">XMLRoot</a></td>
<td class="colLast">
<div class="block">XMLRoot is used to hold an Object along with the corresponding QName and some other related information.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/eclipse/persistence/oxm/XMLUnionField.html" title="class in org.eclipse.persistence.oxm">XMLUnionField</a></td>
<td class="colLast">
<div class="block">Subclass of XMLField for fields that are mapped to unions.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/eclipse/persistence/oxm/XMLUnmarshaller.html" title="class in org.eclipse.persistence.oxm">XMLUnmarshaller</a></td>
<td class="colLast">
<div class="block">Class used to unmarshal XML &amp; JSON to objects.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/eclipse/persistence/oxm/XMLUnmarshallerHandler.html" title="class in org.eclipse.persistence.oxm">XMLUnmarshallerHandler</a></td>
<td class="colLast">
<div class="block">Class used to unmarshal SAX events to objects.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/eclipse/persistence/oxm/XMLValidator.html" title="class in org.eclipse.persistence.oxm">XMLValidator</a></td>
<td class="colLast">
<div class="block">Class used to validate XML.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/eclipse/persistence/oxm/MediaType.html" title="enum in org.eclipse.persistence.oxm">MediaType</a></td>
<td class="colLast">
<div class="block">This enum represents the different media types supported by EclipseLink MOXy.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>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.2, API Reference</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/eclipse/persistence/mappings/xdb/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/eclipse/persistence/oxm/annotations/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/eclipse/persistence/oxm/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p>
</body>
</html>