blob: 62231dbdb492a71343b4b89fdd045e356cd547b9 [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 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>javax.jdo.spi (JDO API 3.2.1)</title>
<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="javax.jdo.spi (JDO API 3.2.1)";
}
}
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-use.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="../../../javax/jdo/query/package-summary.html">Prev&nbsp;Package</a></li>
<li>Next&nbsp;Package</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/jdo/spi/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;javax.jdo.spi</h1>
<div class="docSummary">
<div class="block">This package contains the interfaces and classes used by JDO implementations.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</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="../../../javax/jdo/spi/Detachable.html" title="interface in javax.jdo.spi">Detachable</a></td>
<td class="colLast">
<div class="block">This interface is implemented by classes that can be detached from the
persistence context and later attached.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/jdo/spi/JDOImplHelper.StateInterrogationBooleanReturn.html" title="interface in javax.jdo.spi">JDOImplHelper.StateInterrogationBooleanReturn</a></td>
<td class="colLast">
<div class="block">This is an interface used to interrogate the state of an instance
that does not implement PersistenceCapable.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/jdo/spi/JDOImplHelper.StateInterrogationObjectReturn.html" title="interface in javax.jdo.spi">JDOImplHelper.StateInterrogationObjectReturn</a></td>
<td class="colLast">
<div class="block">This is an interface used to interrogate the state of an instance
that does not implement PersistenceCapable.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/jdo/spi/JDOImplHelper.StringConstructor.html" title="interface in javax.jdo.spi">JDOImplHelper.StringConstructor</a></td>
<td class="colLast">
<div class="block">Construct an instance of a key class using a String as input.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/jdo/spi/PersistenceCapable.html" title="interface in javax.jdo.spi">PersistenceCapable</a></td>
<td class="colLast">
<div class="block">A class that can be managed by a binary-compatible JDO implementation
must implement this interface.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldConsumer.html" title="interface in javax.jdo.spi">PersistenceCapable.ObjectIdFieldConsumer</a></td>
<td class="colLast">
<div class="block">This interface is used to store fields from the Object id instance.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldManager.html" title="interface in javax.jdo.spi">PersistenceCapable.ObjectIdFieldManager</a></td>
<td class="colLast">
<div class="block">This interface is a convenience interface that allows an instance to
implement both <code>ObjectIdFieldSupplier</code> and
<code>ObjectIdFieldConsumer</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldSupplier.html" title="interface in javax.jdo.spi">PersistenceCapable.ObjectIdFieldSupplier</a></td>
<td class="colLast">
<div class="block">This interface is used to provide fields to the Object id instance.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/jdo/spi/RegisterClassListener.html" title="interface in javax.jdo.spi">RegisterClassListener</a></td>
<td class="colLast">
<div class="block">A "RegisterClassEvent" event gets fired whenever a persistence-capable class
is loaded and gets registered with the <code>JDOImplHelper</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/jdo/spi/StateInterrogation.html" title="interface in javax.jdo.spi">StateInterrogation</a></td>
<td class="colLast">
<div class="block">This interface is implemented by a non-binary-compatible JDO implementation
to provide state interrogation for non-enhanced persistent classes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/jdo/spi/StateManager.html" title="interface in javax.jdo.spi">StateManager</a></td>
<td class="colLast">
<div class="block">This interface is the point of contact between managed instances of
<code>PersistenceCapable</code> classes and the JDO implementation.</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="../../../javax/jdo/spi/I18NHelper.html" title="class in javax.jdo.spi">I18NHelper</a></td>
<td class="colLast">
<div class="block">Helper class for constructing messages from bundles.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/jdo/spi/JDOImplHelper.html" title="class in javax.jdo.spi">JDOImplHelper</a></td>
<td class="colLast">
<div class="block">This class is a helper class for JDO implementations.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/jdo/spi/JDOPermission.html" title="class in javax.jdo.spi">JDOPermission</a></td>
<td class="colLast">
<div class="block">The <code>JDOPermission</code> class is for operations that are reserved for
JDO implementations and should not be called by other code.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/jdo/spi/RegisterClassEvent.html" title="class in javax.jdo.spi">RegisterClassEvent</a></td>
<td class="colLast">
<div class="block">A <code>RegisterClassEvent</code> event gets delivered whenever a persistence-capable
class registers itself with the <code>JDOImplHelper</code>.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package javax.jdo.spi Description">Package javax.jdo.spi Description</h2>
<div class="block"><P>This package contains the interfaces and classes used by JDO implementations.
<P>JDO defines interfaces and classes to be used by application programmers
when using classes whose instances are to be stored in persistent storage
(persistence-capable classes), and specifies the contracts between
suppliers of persistence-capable classes and the
runtime environment (which is part of the JDO implementation).
<P>The PersistenceCapable interface is implemented by all classes
whose instances are to be made persistent. The implementation might be
done by a combination of techniques, as determined by the JDO vendor:
<ul>
<li>Pre-processing .java files
<li>Post-processing .class files
<li>Generating .java or .class files directly from an abstraction
</ul>
<P>The StateManager interface is the implementation's contact point with
the PersistenceCapable instances. It defines methods that are called by
the PersistenceCapable instances to implement the required PersistenceCapable
behavior for persistent and transactional instances.
<P>The JDOPermission class is used to manage security controls on JDO implementations.
<P>The RegisterClassEvent class and RegisterClassListener interface are used
by JDO implementations that need access to metadata of PersistenceCapable classes.
<P>The JDOImplHelper class contains helper methods for JDO implementations.</div>
</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-use.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="../../../javax/jdo/query/package-summary.html">Prev&nbsp;Package</a></li>
<li>Next&nbsp;Package</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/jdo/spi/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; 2005&#x2013;2022 <a href="http://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>