You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jdo-commits@db.apache.org by cl...@apache.org on 2005/10/14 07:06:34 UTC
svn commit: r321004 [12/50] - in /incubator/jdo/site: ./ docs/ docs/api11/
docs/api11/apidocs/ docs/api11/apidocs/javax/ docs/api11/apidocs/javax/jdo/
docs/api11/apidocs/javax/jdo/class-use/ docs/api11/apidocs/javax/jdo/spi/
docs/api11/apidocs/javax/jd...
Added: incubator/jdo/site/docs/api11/apidocs/javax/jdo/spi/JDOImplHelper.html
URL: http://svn.apache.org/viewcvs/incubator/jdo/site/docs/api11/apidocs/javax/jdo/spi/JDOImplHelper.html?rev=321004&view=auto
==============================================================================
--- incubator/jdo/site/docs/api11/apidocs/javax/jdo/spi/JDOImplHelper.html (added)
+++ incubator/jdo/site/docs/api11/apidocs/javax/jdo/spi/JDOImplHelper.html Thu Oct 13 22:05:52 2005
@@ -0,0 +1,798 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.4.2_09) on Thu Oct 13 20:55:52 PDT 2005 -->
+<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<TITLE>
+JDOImplHelper (JDO1 API 1.1)
+</TITLE>
+
+<META NAME="keywords" CONTENT="javax.jdo.spi.JDOImplHelper class">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="JDOImplHelper (JDO1 API 1.1)";
+}
+</SCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+
+
+<!-- ========= START OF TOP NAVBAR ======= -->
+<A NAME="navbar_top"><!-- --></A>
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JDOImplHelper.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../javax/jdo/spi/I18NHelper.html" title="class in javax.jdo.spi"><B>PREV CLASS</B></A>
+ <A HREF="../../../javax/jdo/spi/JDOPermission.html" title="class in javax.jdo.spi"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../index.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="JDOImplHelper.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+javax.jdo.spi</FONT>
+<BR>
+Class JDOImplHelper</H2>
+<PRE>
+java.lang.Object
+ <IMG SRC="../../../resources/inherit.gif" ALT="extended by"><B>javax.jdo.spi.JDOImplHelper</B>
+</PRE>
+<HR>
+<DL>
+<DT>public class <B>JDOImplHelper</B><DT>extends java.lang.Object</DL>
+
+<P>
+This class is a helper class for JDO implementations. It contains methods
+ to register metadata for persistence-capable classes and to perform common
+ operations needed by implementations, not by end users.
+ <P><code>JDOImplHelper</code> allows construction of instances of persistence-capable
+ classes without using reflection.
+ <P>Persistence-capable classes register themselves via a static method
+ at class load time.
+ There is no security restriction on this access. JDO implementations
+ get access to the functions provided by this class only if they are
+ authorized by the security manager. To avoid having every call go through
+ the security manager, only the call to get an instance is checked. Once an
+ implementation
+ has an instance, any of the methods can be invoked without security checks.
+<P>
+
+<P>
+<DL>
+<DT><B>Version:</B></DT>
+ <DD>1.0.2</DD>
+<DT><B>Author:</B></DT>
+ <DD>Craig Russell</DD>
+</DL>
+<HR>
+
+<P>
+<!-- ======== NESTED CLASS SUMMARY ======== -->
+
+
+<!-- =========== FIELD SUMMARY =========== -->
+
+
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+
+
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TD COLSPAN=2><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/JDOImplHelper.html#addRegisterClassListener(javax.jdo.spi.RegisterClassListener)">addRegisterClassListener</A></B>(<A HREF="../../../javax/jdo/spi/RegisterClassListener.html" title="interface in javax.jdo.spi">RegisterClassListener</A> crl)</CODE>
+
+<BR>
+ Add the specified <code>RegisterClassListener</code> to the listener list.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/JDOImplHelper.html#checkAuthorizedStateManager(javax.jdo.spi.StateManager)">checkAuthorizedStateManager</A></B>(<A HREF="../../../javax/jdo/spi/StateManager.html" title="interface in javax.jdo.spi">StateManager</A> sm)</CODE>
+
+<BR>
+ Check that the parameter instance is of a class that is authorized for
+ JDOPermission("setStateManager").</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/JDOImplHelper.html#checkAuthorizedStateManagerClass(java.lang.Class)">checkAuthorizedStateManagerClass</A></B>(java.lang.Class smClass)</CODE>
+
+<BR>
+ Check that the parameter instance is a class that is authorized for
+ JDOPermission("setStateManager").</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/JDOImplHelper.html#copyKeyFieldsFromObjectId(java.lang.Class, javax.jdo.spi.PersistenceCapable.ObjectIdFieldConsumer, java.lang.Object)">copyKeyFieldsFromObjectId</A></B>(java.lang.Class pcClass,
+ <A HREF="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldConsumer.html" title="interface in javax.jdo.spi">PersistenceCapable.ObjectIdFieldConsumer</A> fm,
+ java.lang.Object oid)</CODE>
+
+<BR>
+ Copy fields to an outside source from the key fields in the ObjectId.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/JDOImplHelper.html#copyKeyFieldsToObjectId(java.lang.Class, javax.jdo.spi.PersistenceCapable.ObjectIdFieldSupplier, java.lang.Object)">copyKeyFieldsToObjectId</A></B>(java.lang.Class pcClass,
+ <A HREF="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldSupplier.html" title="interface in javax.jdo.spi">PersistenceCapable.ObjectIdFieldSupplier</A> fm,
+ java.lang.Object oid)</CODE>
+
+<BR>
+ Copy fields from an outside source to the key fields in the ObjectId.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> byte[]</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/JDOImplHelper.html#getFieldFlags(java.lang.Class)">getFieldFlags</A></B>(java.lang.Class pcClass)</CODE>
+
+<BR>
+ Get the field flags for a <code>PersistenceCapable</code> class.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.String[]</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/JDOImplHelper.html#getFieldNames(java.lang.Class)">getFieldNames</A></B>(java.lang.Class pcClass)</CODE>
+
+<BR>
+ Get the field names for a <code>PersistenceCapable</code> class.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.Class[]</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/JDOImplHelper.html#getFieldTypes(java.lang.Class)">getFieldTypes</A></B>(java.lang.Class pcClass)</CODE>
+
+<BR>
+ Get the field types for a <code>PersistenceCapable</code> class.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static <A HREF="../../../javax/jdo/spi/JDOImplHelper.html" title="class in javax.jdo.spi">JDOImplHelper</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/JDOImplHelper.html#getInstance()">getInstance</A></B>()</CODE>
+
+<BR>
+ Get an instance of <code>JDOImplHelper</code>.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.Class</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/JDOImplHelper.html#getPersistenceCapableSuperclass(java.lang.Class)">getPersistenceCapableSuperclass</A></B>(java.lang.Class pcClass)</CODE>
+
+<BR>
+ Get the persistence-capable superclass for a <code>PersistenceCapable</code> class.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.util.Collection</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/JDOImplHelper.html#getRegisteredClasses()">getRegisteredClasses</A></B>()</CODE>
+
+<BR>
+ Returns a collection of class objects of the registered
+ persistence-capable classes.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A HREF="../../../javax/jdo/spi/PersistenceCapable.html" title="interface in javax.jdo.spi">PersistenceCapable</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/JDOImplHelper.html#newInstance(java.lang.Class, javax.jdo.spi.StateManager)">newInstance</A></B>(java.lang.Class pcClass,
+ <A HREF="../../../javax/jdo/spi/StateManager.html" title="interface in javax.jdo.spi">StateManager</A> sm)</CODE>
+
+<BR>
+ Create a new instance of the class and assign its <code>jdoStateManager</code>.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A HREF="../../../javax/jdo/spi/PersistenceCapable.html" title="interface in javax.jdo.spi">PersistenceCapable</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/JDOImplHelper.html#newInstance(java.lang.Class, javax.jdo.spi.StateManager, java.lang.Object)">newInstance</A></B>(java.lang.Class pcClass,
+ <A HREF="../../../javax/jdo/spi/StateManager.html" title="interface in javax.jdo.spi">StateManager</A> sm,
+ java.lang.Object oid)</CODE>
+
+<BR>
+ Create a new instance of the class and assign its <code>jdoStateManager</code> and
+ key values from the ObjectId.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.Object</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/JDOImplHelper.html#newObjectIdInstance(java.lang.Class)">newObjectIdInstance</A></B>(java.lang.Class pcClass)</CODE>
+
+<BR>
+ Create a new instance of the ObjectId class of this
+ <code>PersistenceCapable</code> class.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.Object</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/JDOImplHelper.html#newObjectIdInstance(java.lang.Class, java.lang.String)">newObjectIdInstance</A></B>(java.lang.Class pcClass,
+ java.lang.String str)</CODE>
+
+<BR>
+ Create a new instance of the ObjectId class of this <code>PersistenceCapable</code>
+ class, using the <code>String</code> form of the constructor.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/JDOImplHelper.html#registerAuthorizedStateManagerClass(java.lang.Class)">registerAuthorizedStateManagerClass</A></B>(java.lang.Class smClass)</CODE>
+
+<BR>
+ Register a class authorized to replaceStateManager.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/JDOImplHelper.html#registerAuthorizedStateManagerClasses(java.util.Collection)">registerAuthorizedStateManagerClasses</A></B>(java.util.Collection smClasses)</CODE>
+
+<BR>
+ Register classes authorized to replaceStateManager.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/JDOImplHelper.html#registerClass(java.lang.Class, java.lang.String[], java.lang.Class[], byte[], java.lang.Class, javax.jdo.spi.PersistenceCapable)">registerClass</A></B>(java.lang.Class pcClass,
+ java.lang.String[] fieldNames,
+ java.lang.Class[] fieldTypes,
+ byte[] fieldFlags,
+ java.lang.Class persistenceCapableSuperclass,
+ <A HREF="../../../javax/jdo/spi/PersistenceCapable.html" title="interface in javax.jdo.spi">PersistenceCapable</A> pc)</CODE>
+
+<BR>
+ Register metadata by class.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/JDOImplHelper.html#removeRegisterClassListener(javax.jdo.spi.RegisterClassListener)">removeRegisterClassListener</A></B>(<A HREF="../../../javax/jdo/spi/RegisterClassListener.html" title="interface in javax.jdo.spi">RegisterClassListener</A> crl)</CODE>
+
+<BR>
+ Remove the specified <code>RegisterClassListener</code> from the listener list.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/JDOImplHelper.html#unregisterClass(java.lang.Class)">unregisterClass</A></B>(java.lang.Class pcClass)</CODE>
+
+<BR>
+ Unregister metadata by class.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/JDOImplHelper.html#unregisterClasses(java.lang.ClassLoader)">unregisterClasses</A></B>(java.lang.ClassLoader cl)</CODE>
+
+<BR>
+ Unregister metadata by class loader.</TD>
+</TR>
+</TABLE>
+ <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TD><B>Methods inherited from class java.lang.Object</B></TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
+</TR>
+</TABLE>
+
+<P>
+
+<!-- ============ FIELD DETAIL =========== -->
+
+
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TD COLSPAN=1><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TD>
+</TR>
+</TABLE>
+
+<A NAME="getInstance()"><!-- --></A><H3>
+getInstance</H3>
+<PRE>
+public static <A HREF="../../../javax/jdo/spi/JDOImplHelper.html" title="class in javax.jdo.spi">JDOImplHelper</A> <B>getInstance</B>()
+ throws java.lang.SecurityException</PRE>
+<DL>
+<DD>Get an instance of <code>JDOImplHelper</code>. This method
+ checks that the caller is authorized for <code>JDOPermission("getMetadata")</code>,
+ and if not, throws <code>SecurityException</code>.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>an instance of <code>JDOImplHelper</code>.
+<DT><B>Throws:</B>
+<DD><CODE>java.lang.SecurityException</CODE> - if the caller is not authorized for JDOPermission("getMetadata").</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getFieldNames(java.lang.Class)"><!-- --></A><H3>
+getFieldNames</H3>
+<PRE>
+public java.lang.String[] <B>getFieldNames</B>(java.lang.Class pcClass)</PRE>
+<DL>
+<DD>Get the field names for a <code>PersistenceCapable</code> class. The order
+ of fields is the natural ordering of the <code>String</code> class (without
+ considering localization).
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>pcClass</CODE> - the <code>PersistenceCapable</code> class.
+<DT><B>Returns:</B><DD>the field names for the class.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getFieldTypes(java.lang.Class)"><!-- --></A><H3>
+getFieldTypes</H3>
+<PRE>
+public java.lang.Class[] <B>getFieldTypes</B>(java.lang.Class pcClass)</PRE>
+<DL>
+<DD>Get the field types for a <code>PersistenceCapable</code> class. The order
+ of fields is the same as for field names.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>pcClass</CODE> - the <code>PersistenceCapable</code> class.
+<DT><B>Returns:</B><DD>the field types for the class.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getFieldFlags(java.lang.Class)"><!-- --></A><H3>
+getFieldFlags</H3>
+<PRE>
+public byte[] <B>getFieldFlags</B>(java.lang.Class pcClass)</PRE>
+<DL>
+<DD>Get the field flags for a <code>PersistenceCapable</code> class. The order
+ of fields is the same as for field names.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>pcClass</CODE> - the <code>PersistenceCapable</code> class.
+<DT><B>Returns:</B><DD>the field types for the class.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getPersistenceCapableSuperclass(java.lang.Class)"><!-- --></A><H3>
+getPersistenceCapableSuperclass</H3>
+<PRE>
+public java.lang.Class <B>getPersistenceCapableSuperclass</B>(java.lang.Class pcClass)</PRE>
+<DL>
+<DD>Get the persistence-capable superclass for a <code>PersistenceCapable</code> class.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>pcClass</CODE> - the <code>PersistenceCapable</code> class.
+<DT><B>Returns:</B><DD>The <code>PersistenceCapable</code> superclass for this class,
+ or <code>null</code> if there isn't one.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="newInstance(java.lang.Class, javax.jdo.spi.StateManager)"><!-- --></A><H3>
+newInstance</H3>
+<PRE>
+public <A HREF="../../../javax/jdo/spi/PersistenceCapable.html" title="interface in javax.jdo.spi">PersistenceCapable</A> <B>newInstance</B>(java.lang.Class pcClass,
+ <A HREF="../../../javax/jdo/spi/StateManager.html" title="interface in javax.jdo.spi">StateManager</A> sm)</PRE>
+<DL>
+<DD>Create a new instance of the class and assign its <code>jdoStateManager</code>.
+ The new instance has its <code>jdoFlags</code> set to <code>LOAD_REQUIRED</code>.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>pcClass</CODE> - the <code>PersistenceCapable</code> class.<DD><CODE>sm</CODE> - the <code>StateManager</code> which will own the new instance.
+<DT><B>Returns:</B><DD>the new instance, or <code>null</code> if the class is not registered.<DT><B>See Also:</B><DD><A HREF="../../../javax/jdo/spi/PersistenceCapable.html#jdoNewInstance(javax.jdo.spi.StateManager)"><CODE>PersistenceCapable.jdoNewInstance(StateManager sm)</CODE></A></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="newInstance(java.lang.Class, javax.jdo.spi.StateManager, java.lang.Object)"><!-- --></A><H3>
+newInstance</H3>
+<PRE>
+public <A HREF="../../../javax/jdo/spi/PersistenceCapable.html" title="interface in javax.jdo.spi">PersistenceCapable</A> <B>newInstance</B>(java.lang.Class pcClass,
+ <A HREF="../../../javax/jdo/spi/StateManager.html" title="interface in javax.jdo.spi">StateManager</A> sm,
+ java.lang.Object oid)</PRE>
+<DL>
+<DD>Create a new instance of the class and assign its <code>jdoStateManager</code> and
+ key values from the ObjectId. If the oid parameter is <code>null</code>,
+ no key values are copied.
+ The new instance has its <code>jdoFlags</code> set to <code>LOAD_REQUIRED</code>.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>pcClass</CODE> - the <code>PersistenceCapable</code> class.<DD><CODE>sm</CODE> - the <code>StateManager</code> which will own the new instance.<DD><CODE>oid</CODE> - the ObjectId instance from which to copy key field values.
+<DT><B>Returns:</B><DD>the new instance, or <code>null</code> if the class is not registered.<DT><B>See Also:</B><DD><A HREF="../../../javax/jdo/spi/PersistenceCapable.html#jdoNewInstance(javax.jdo.spi.StateManager, java.lang.Object)"><CODE>PersistenceCapable.jdoNewInstance(StateManager sm, Object oid)</CODE></A></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="newObjectIdInstance(java.lang.Class)"><!-- --></A><H3>
+newObjectIdInstance</H3>
+<PRE>
+public java.lang.Object <B>newObjectIdInstance</B>(java.lang.Class pcClass)</PRE>
+<DL>
+<DD>Create a new instance of the ObjectId class of this
+ <code>PersistenceCapable</code> class.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>pcClass</CODE> - the <code>PersistenceCapable</code> class.
+<DT><B>Returns:</B><DD>the new ObjectId instance, or <code>null</code> if the class is not registered.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="newObjectIdInstance(java.lang.Class, java.lang.String)"><!-- --></A><H3>
+newObjectIdInstance</H3>
+<PRE>
+public java.lang.Object <B>newObjectIdInstance</B>(java.lang.Class pcClass,
+ java.lang.String str)</PRE>
+<DL>
+<DD>Create a new instance of the ObjectId class of this <code>PersistenceCapable</code>
+ class, using the <code>String</code> form of the constructor.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>str</CODE> - the <code>String</code> form of the object id<DD><CODE>pcClass</CODE> - the <code>PersistenceCapable</code> class.
+<DT><B>Returns:</B><DD>the new ObjectId instance, or <code>null</code> if the class is not registered.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="copyKeyFieldsToObjectId(java.lang.Class, javax.jdo.spi.PersistenceCapable.ObjectIdFieldSupplier, java.lang.Object)"><!-- --></A><H3>
+copyKeyFieldsToObjectId</H3>
+<PRE>
+public void <B>copyKeyFieldsToObjectId</B>(java.lang.Class pcClass,
+ <A HREF="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldSupplier.html" title="interface in javax.jdo.spi">PersistenceCapable.ObjectIdFieldSupplier</A> fm,
+ java.lang.Object oid)</PRE>
+<DL>
+<DD>Copy fields from an outside source to the key fields in the ObjectId.
+ This method is generated in the <code>PersistenceCapable</code> class to
+ generate a call to the field manager for each key field in the ObjectId.
+ <P>For example, an ObjectId class that has three key fields (<code>int id</code>,
+ <code>String name</code>, and <code>Float salary</code>) would have the method generated:
+ <P><code>
+ void jdoCopyKeyFieldsToObjectId (Object oid, ObjectIdFieldSupplier fm) {
+ <BR> oid.id = fm.fetchIntField (0);
+ <BR> oid.name = fm.fetchStringField (1);
+ <BR> oid.salary = fm.fetchObjectField (2);
+ <BR>}</code>
+ <P>The implementation is responsible for implementing the
+ <code>ObjectIdFieldSupplier</code> to provide the values for the key fields.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>pcClass</CODE> - the <code>PersistenceCapable Class</code>.<DD><CODE>oid</CODE> - the ObjectId target of the copy.<DD><CODE>fm</CODE> - the field manager that supplies the field values.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="copyKeyFieldsFromObjectId(java.lang.Class, javax.jdo.spi.PersistenceCapable.ObjectIdFieldConsumer, java.lang.Object)"><!-- --></A><H3>
+copyKeyFieldsFromObjectId</H3>
+<PRE>
+public void <B>copyKeyFieldsFromObjectId</B>(java.lang.Class pcClass,
+ <A HREF="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldConsumer.html" title="interface in javax.jdo.spi">PersistenceCapable.ObjectIdFieldConsumer</A> fm,
+ java.lang.Object oid)</PRE>
+<DL>
+<DD>Copy fields to an outside source from the key fields in the ObjectId.
+ This method is generated in the <code>PersistenceCapable</code> class to generate
+ a call to the field manager for each key field in the ObjectId. For
+ example, an ObjectId class that has three key fields (<code>int id</code>,
+ <code>String name</code>, and <code>Float salary</code>) would have the method generated:
+ <P><code>void jdoCopyKeyFieldsFromObjectId
+ <BR> (PersistenceCapable oid, ObjectIdFieldConsumer fm) {
+ <BR> fm.storeIntField (0, oid.id);
+ <BR> fm.storeStringField (1, oid.name);
+ <BR> fm.storeObjectField (2, oid.salary);
+ <BR>}</code>
+ <P>The implementation is responsible for implementing the
+ <code>ObjectIdFieldConsumer</code> to store the values for the key fields.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>pcClass</CODE> - the <code>PersistenceCapable</code> class<DD><CODE>oid</CODE> - the ObjectId source of the copy.<DD><CODE>fm</CODE> - the field manager that receives the field values.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="registerClass(java.lang.Class, java.lang.String[], java.lang.Class[], byte[], java.lang.Class, javax.jdo.spi.PersistenceCapable)"><!-- --></A><H3>
+registerClass</H3>
+<PRE>
+public static void <B>registerClass</B>(java.lang.Class pcClass,
+ java.lang.String[] fieldNames,
+ java.lang.Class[] fieldTypes,
+ byte[] fieldFlags,
+ java.lang.Class persistenceCapableSuperclass,
+ <A HREF="../../../javax/jdo/spi/PersistenceCapable.html" title="interface in javax.jdo.spi">PersistenceCapable</A> pc)</PRE>
+<DL>
+<DD>Register metadata by class. The registration will be done in the
+ class named <code>JDOImplHelper</code> loaded by the same or an
+ ancestor class loader as the <code>PersistenceCapable</code> class
+ performing the registration.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>pcClass</CODE> - the <code>PersistenceCapable</code> class
+ used as the key for lookup.<DD><CODE>fieldNames</CODE> - an array of <code>String</code> field names for persistent and transactional fields<DD><CODE>fieldTypes</CODE> - an array of <code>Class</code> field types<DD><CODE>fieldFlags</CODE> - the Field Flags for persistent and transactional fields<DD><CODE>pc</CODE> - an instance of the <code>PersistenceCapable</code> class<DD><CODE>persistenceCapableSuperclass</CODE> - the most immediate superclass that is <code>PersistenceCapable</code></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="unregisterClasses(java.lang.ClassLoader)"><!-- --></A><H3>
+unregisterClasses</H3>
+<PRE>
+public void <B>unregisterClasses</B>(java.lang.ClassLoader cl)</PRE>
+<DL>
+<DD>Unregister metadata by class loader. This method unregisters all
+ registered <code>PersistenceCapable</code> classes loaded by the
+ specified class loader. Any attempt to get metadata for unregistered
+ classes will result in a <code>JDOFatalUserException</code>.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>cl</CODE> - the class loader.<DT><B>Since:</B></DT>
+ <DD>1.0.2</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="unregisterClass(java.lang.Class)"><!-- --></A><H3>
+unregisterClass</H3>
+<PRE>
+public void <B>unregisterClass</B>(java.lang.Class pcClass)</PRE>
+<DL>
+<DD>Unregister metadata by class. This method unregisters the specified
+ class. Any further attempt to get metadata for the specified class will
+ result in a <code>JDOFatalUserException</code>.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>pcClass</CODE> - the <code>PersistenceCapable</code> class to be unregistered.<DT><B>Since:</B></DT>
+ <DD>1.0.2</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="addRegisterClassListener(javax.jdo.spi.RegisterClassListener)"><!-- --></A><H3>
+addRegisterClassListener</H3>
+<PRE>
+public void <B>addRegisterClassListener</B>(<A HREF="../../../javax/jdo/spi/RegisterClassListener.html" title="interface in javax.jdo.spi">RegisterClassListener</A> crl)</PRE>
+<DL>
+<DD>Add the specified <code>RegisterClassListener</code> to the listener list.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>crl</CODE> - the listener to be added</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="removeRegisterClassListener(javax.jdo.spi.RegisterClassListener)"><!-- --></A><H3>
+removeRegisterClassListener</H3>
+<PRE>
+public void <B>removeRegisterClassListener</B>(<A HREF="../../../javax/jdo/spi/RegisterClassListener.html" title="interface in javax.jdo.spi">RegisterClassListener</A> crl)</PRE>
+<DL>
+<DD>Remove the specified <code>RegisterClassListener</code> from the listener list.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>crl</CODE> - the listener to be removed</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getRegisteredClasses()"><!-- --></A><H3>
+getRegisteredClasses</H3>
+<PRE>
+public java.util.Collection <B>getRegisteredClasses</B>()</PRE>
+<DL>
+<DD>Returns a collection of class objects of the registered
+ persistence-capable classes.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>registered persistence-capable classes</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="registerAuthorizedStateManagerClass(java.lang.Class)"><!-- --></A><H3>
+registerAuthorizedStateManagerClass</H3>
+<PRE>
+public static void <B>registerAuthorizedStateManagerClass</B>(java.lang.Class smClass)
+ throws java.lang.SecurityException</PRE>
+<DL>
+<DD>Register a class authorized to replaceStateManager. The caller of
+ this method must be authorized for JDOPermission("setStateManager").
+ During replaceStateManager, a persistence-capable class will call
+ the corresponding checkAuthorizedStateManager and the class of the
+ instance of the parameter must have been registered.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>smClass</CODE> - a Class that is authorized for JDOPermission("setStateManager").
+<DT><B>Throws:</B>
+<DD><CODE>java.lang.SecurityException</CODE> - if the caller is not authorized for JDOPermission("setStateManager").<DT><B>Since:</B></DT>
+ <DD>1.0.1</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="registerAuthorizedStateManagerClasses(java.util.Collection)"><!-- --></A><H3>
+registerAuthorizedStateManagerClasses</H3>
+<PRE>
+public static void <B>registerAuthorizedStateManagerClasses</B>(java.util.Collection smClasses)
+ throws java.lang.SecurityException</PRE>
+<DL>
+<DD>Register classes authorized to replaceStateManager. The caller of
+ this method must be authorized for JDOPermission("setStateManager").
+ During replaceStateManager, a persistence-capable class will call
+ the corresponding checkAuthorizedStateManager and the class of the
+ instance of the parameter must have been registered.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>smClasses</CODE> - a Collection of Classes that are authorized for JDOPermission("setStateManager").
+<DT><B>Throws:</B>
+<DD><CODE>java.lang.SecurityException</CODE> - if the caller is not authorized for JDOPermission("setStateManager").<DT><B>Since:</B></DT>
+ <DD>1.0.1</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="checkAuthorizedStateManager(javax.jdo.spi.StateManager)"><!-- --></A><H3>
+checkAuthorizedStateManager</H3>
+<PRE>
+public static void <B>checkAuthorizedStateManager</B>(<A HREF="../../../javax/jdo/spi/StateManager.html" title="interface in javax.jdo.spi">StateManager</A> sm)</PRE>
+<DL>
+<DD>Check that the parameter instance is of a class that is authorized for
+ JDOPermission("setStateManager"). This method is called by the
+ replaceStateManager method in persistence-capable classes.
+ A class that is passed as the parameter to replaceStateManager must be
+ authorized for JDOPermission("setStateManager"). To improve performance,
+ first the set of authorized classes is checked, and if not present, a
+ regular permission check is made. The regular permission check requires
+ that all callers on the stack, including the persistence-capable class
+ itself, must be authorized for JDOPermission("setStateManager").
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>sm</CODE> - an instance of StateManager whose class is to be checked.<DT><B>Since:</B></DT>
+ <DD>1.0.1</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="checkAuthorizedStateManagerClass(java.lang.Class)"><!-- --></A><H3>
+checkAuthorizedStateManagerClass</H3>
+<PRE>
+public static void <B>checkAuthorizedStateManagerClass</B>(java.lang.Class smClass)</PRE>
+<DL>
+<DD>Check that the parameter instance is a class that is authorized for
+ JDOPermission("setStateManager"). This method is called by the
+ constructors of JDO Reference Implementation classes.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>smClass</CODE> - a Class to be checked for JDOPermission("setStateManager")<DT><B>Since:</B></DT>
+ <DD>1.0.1</DD>
+</DL>
+</DD>
+</DL>
+<!-- ========= END OF CLASS DATA ========= -->
+<HR>
+
+
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<A NAME="navbar_bottom"><!-- --></A>
+<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_bottom_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JDOImplHelper.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../javax/jdo/spi/I18NHelper.html" title="class in javax.jdo.spi"><B>PREV CLASS</B></A>
+ <A HREF="../../../javax/jdo/spi/JDOPermission.html" title="class in javax.jdo.spi"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../index.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="JDOImplHelper.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+Copyright © 2005 Apache Software Foundation. All Rights Reserved.
+</BODY>
+</HTML>
Added: incubator/jdo/site/docs/api11/apidocs/javax/jdo/spi/JDOPermission.html
URL: http://svn.apache.org/viewcvs/incubator/jdo/site/docs/api11/apidocs/javax/jdo/spi/JDOPermission.html?rev=321004&view=auto
==============================================================================
--- incubator/jdo/site/docs/api11/apidocs/javax/jdo/spi/JDOPermission.html (added)
+++ incubator/jdo/site/docs/api11/apidocs/javax/jdo/spi/JDOPermission.html Thu Oct 13 22:05:52 2005
@@ -0,0 +1,438 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.4.2_09) on Thu Oct 13 20:55:52 PDT 2005 -->
+<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<TITLE>
+JDOPermission (JDO1 API 1.1)
+</TITLE>
+
+<META NAME="keywords" CONTENT="javax.jdo.spi.JDOPermission class">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="JDOPermission (JDO1 API 1.1)";
+}
+</SCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+
+
+<!-- ========= START OF TOP NAVBAR ======= -->
+<A NAME="navbar_top"><!-- --></A>
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JDOPermission.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../javax/jdo/spi/JDOImplHelper.html" title="class in javax.jdo.spi"><B>PREV CLASS</B></A>
+ <A HREF="../../../javax/jdo/spi/RegisterClassEvent.html" title="class in javax.jdo.spi"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../index.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="JDOPermission.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#methods_inherited_from_class_java.security.BasicPermission">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | METHOD</FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+javax.jdo.spi</FONT>
+<BR>
+Class JDOPermission</H2>
+<PRE>
+java.lang.Object
+ <IMG SRC="../../../resources/inherit.gif" ALT="extended by">java.security.Permission
+ <IMG SRC="../../../resources/inherit.gif" ALT="extended by">java.security.BasicPermission
+ <IMG SRC="../../../resources/inherit.gif" ALT="extended by"><B>javax.jdo.spi.JDOPermission</B>
+</PRE>
+<DL>
+<DT><B>All Implemented Interfaces:</B> <DD>java.security.Guard, java.io.Serializable</DD>
+</DL>
+<HR>
+<DL>
+<DT>public final class <B>JDOPermission</B><DT>extends java.security.BasicPermission</DL>
+
+<P>
+The <code>JDOPermission</code> class is for operations that are reserved for JDO
+ implementations and should not be called by other code. A
+ <code>JDOPermission</code> is a <em>named permission</em> and has no
+ actions. There are two names currently defined. Each named permission
+ has a corresponding public static final field which contains an instance
+ of the named permission.
+ <P>
+ The following table
+ provides a summary description of what each named permission allows,
+ and discusses the risks of granting code the permission.
+ <P>
+
+ <table border=1 cellpadding=5>
+ <tr>
+ <th>Permission Target Name</th>
+ <th>What the Permission Allows</th>
+ <th>Risks of Allowing this Permission</th>
+ </tr>
+
+ <tr>
+ <td><code>setStateManager</code></td>
+ <td>This allows setting the <code>StateManager</code> for an instance of <code>PersistenceCapable</code>.
+ The <code>StateManager</code>
+ has unlimited access to get and set persistent and transactional fields of
+ the <code>PersistenceCapable</code> instance.</td>
+ <td>This is dangerous in that information (possibly confidential)
+ normally unavailable would be accessible to malicious code.</td>
+ </tr>
+
+ <tr>
+ <td><code>getMetadata</code></td>
+ <td>This allows getting metadata for any <code>PersistenceCapable</code> class that has
+ registered with <code>JDOImplHelper</code>.</td>
+ <td>This is dangerous in that metadata information (possibly confidential)
+ normally unavailable would be accessible to malicious code.</td>
+ </tr>
+
+ <tr>
+ <td><code>manageMetadata</code></td>
+ <td>This allows managing metadata for any <code>PersistenceCapable</code> class that has
+ registered with <code>JDOImplHelper</code>.</td>
+ <td>This is dangerous in that metadata information (possibly confidential)
+ normally unavailable would be manageable (modifiable) by malicious code.</td>
+ </tr>
+
+ <tr>
+ <td><code>closePersistenceManagerFactory</code></td>
+ <td>This allows closing a <code>PersistenceManagerFactory</code>,
+ thereby releasing resources.</td>
+ <td>This is dangerous in that resources bound to the
+ <code>PersistenceManagerFactory</code> would be releaseable by
+ malicious code.</td>
+ </tr>
+
+ </table>
+<P>
+
+<P>
+<DL>
+<DT><B>Version:</B></DT>
+ <DD>1.0.2</DD>
+<DT><B>See Also:</B><DD><CODE>Permission</CODE>,
+<CODE>BasicPermission</CODE>,
+<A HREF="../../../javax/jdo/spi/JDOImplHelper.html" title="class in javax.jdo.spi"><CODE>JDOImplHelper</CODE></A>,
+<A HREF="../../../javax/jdo/spi/PersistenceCapable.html" title="interface in javax.jdo.spi"><CODE>PersistenceCapable</CODE></A>,
+<A HREF="../../../serialized-form.html#javax.jdo.spi.JDOPermission">Serialized Form</A></DL>
+<HR>
+
+<P>
+<!-- ======== NESTED CLASS SUMMARY ======== -->
+
+
+<!-- =========== FIELD SUMMARY =========== -->
+
+<A NAME="field_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TD COLSPAN=2><FONT SIZE="+2">
+<B>Field Summary</B></FONT></TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static <A HREF="../../../javax/jdo/spi/JDOPermission.html" title="class in javax.jdo.spi">JDOPermission</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/JDOPermission.html#CLOSE_PERSISTENCE_MANAGER_FACTORY">CLOSE_PERSISTENCE_MANAGER_FACTORY</A></B></CODE>
+
+<BR>
+ An instance of <code>JDOPermission</code> to be used for
+ <code>closePersistenceManagerFactory</code> permission checking.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static <A HREF="../../../javax/jdo/spi/JDOPermission.html" title="class in javax.jdo.spi">JDOPermission</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/JDOPermission.html#GET_METADATA">GET_METADATA</A></B></CODE>
+
+<BR>
+ An instance of <code>JDOPermission</code> to be used for
+ <code>getMetadata</code> permission checking.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static <A HREF="../../../javax/jdo/spi/JDOPermission.html" title="class in javax.jdo.spi">JDOPermission</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/JDOPermission.html#MANAGE_METADATA">MANAGE_METADATA</A></B></CODE>
+
+<BR>
+ An instance of <code>JDOPermission</code> to be used for
+ <code>manageMetadata</code> permission checking.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static <A HREF="../../../javax/jdo/spi/JDOPermission.html" title="class in javax.jdo.spi">JDOPermission</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/JDOPermission.html#SET_STATE_MANAGER">SET_STATE_MANAGER</A></B></CODE>
+
+<BR>
+ An instance of <code>JDOPermission</code> to be used for
+ <code>setStateManager</code> permission checking.</TD>
+</TR>
+</TABLE>
+
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+
+<A NAME="constructor_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TD COLSPAN=2><FONT SIZE="+2">
+<B>Constructor Summary</B></FONT></TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/JDOPermission.html#JDOPermission(java.lang.String)">JDOPermission</A></B>(java.lang.String name)</CODE>
+
+<BR>
+ Constructs a <code>JDOPermission</code> with the specified name.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/JDOPermission.html#JDOPermission(java.lang.String, java.lang.String)">JDOPermission</A></B>(java.lang.String name,
+ java.lang.String actions)</CODE>
+
+<BR>
+ Constructs a <code>JDOPermission</code> with the specified name and actions.</TD>
+</TR>
+</TABLE>
+
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="methods_inherited_from_class_java.security.BasicPermission"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TD><B>Methods inherited from class java.security.BasicPermission</B></TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE>equals, getActions, hashCode, implies, newPermissionCollection</CODE></TD>
+</TR>
+</TABLE>
+ <A NAME="methods_inherited_from_class_java.security.Permission"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TD><B>Methods inherited from class java.security.Permission</B></TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE>checkGuard, getName, toString</CODE></TD>
+</TR>
+</TABLE>
+ <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TD><B>Methods inherited from class java.lang.Object</B></TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</CODE></TD>
+</TR>
+</TABLE>
+
+<P>
+
+<!-- ============ FIELD DETAIL =========== -->
+
+<A NAME="field_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TD COLSPAN=1><FONT SIZE="+2">
+<B>Field Detail</B></FONT></TD>
+</TR>
+</TABLE>
+
+<A NAME="GET_METADATA"><!-- --></A><H3>
+GET_METADATA</H3>
+<PRE>
+public static final <A HREF="../../../javax/jdo/spi/JDOPermission.html" title="class in javax.jdo.spi">JDOPermission</A> <B>GET_METADATA</B></PRE>
+<DL>
+<DD>An instance of <code>JDOPermission</code> to be used for
+ <code>getMetadata</code> permission checking.
+<P>
+<DL>
+</DL>
+</DL>
+<HR>
+
+<A NAME="MANAGE_METADATA"><!-- --></A><H3>
+MANAGE_METADATA</H3>
+<PRE>
+public static final <A HREF="../../../javax/jdo/spi/JDOPermission.html" title="class in javax.jdo.spi">JDOPermission</A> <B>MANAGE_METADATA</B></PRE>
+<DL>
+<DD>An instance of <code>JDOPermission</code> to be used for
+ <code>manageMetadata</code> permission checking.
+<P>
+<DL>
+<DT><B>Since:</B></DT>
+ <DD>1.0.2</DD>
+</DL>
+</DL>
+<HR>
+
+<A NAME="SET_STATE_MANAGER"><!-- --></A><H3>
+SET_STATE_MANAGER</H3>
+<PRE>
+public static final <A HREF="../../../javax/jdo/spi/JDOPermission.html" title="class in javax.jdo.spi">JDOPermission</A> <B>SET_STATE_MANAGER</B></PRE>
+<DL>
+<DD>An instance of <code>JDOPermission</code> to be used for
+ <code>setStateManager</code> permission checking.
+<P>
+<DL>
+</DL>
+</DL>
+<HR>
+
+<A NAME="CLOSE_PERSISTENCE_MANAGER_FACTORY"><!-- --></A><H3>
+CLOSE_PERSISTENCE_MANAGER_FACTORY</H3>
+<PRE>
+public static final <A HREF="../../../javax/jdo/spi/JDOPermission.html" title="class in javax.jdo.spi">JDOPermission</A> <B>CLOSE_PERSISTENCE_MANAGER_FACTORY</B></PRE>
+<DL>
+<DD>An instance of <code>JDOPermission</code> to be used for
+ <code>closePersistenceManagerFactory</code> permission checking.
+<P>
+<DL>
+<DT><B>Since:</B></DT>
+ <DD>1.0.1</DD>
+</DL>
+</DL>
+
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+
+<A NAME="constructor_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TD COLSPAN=1><FONT SIZE="+2">
+<B>Constructor Detail</B></FONT></TD>
+</TR>
+</TABLE>
+
+<A NAME="JDOPermission(java.lang.String)"><!-- --></A><H3>
+JDOPermission</H3>
+<PRE>
+public <B>JDOPermission</B>(java.lang.String name)</PRE>
+<DL>
+<DD>Constructs a <code>JDOPermission</code> with the specified name.
+<P>
+<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the <code>JDOPermission</code></DL>
+<HR>
+
+<A NAME="JDOPermission(java.lang.String, java.lang.String)"><!-- --></A><H3>
+JDOPermission</H3>
+<PRE>
+public <B>JDOPermission</B>(java.lang.String name,
+ java.lang.String actions)</PRE>
+<DL>
+<DD>Constructs a <code>JDOPermission</code> with the specified name and actions.
+ The actions should be <code>null</code>; they are ignored. This
+ constructor exists for use by the <code>Policy</code> object
+ to instantiate new <code>Permission</code> objects.
+<P>
+<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the <code>JDOPermission</code><DD><CODE>actions</CODE> - should be <code>null</code>.</DL>
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<!-- ========= END OF CLASS DATA ========= -->
+<HR>
+
+
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<A NAME="navbar_bottom"><!-- --></A>
+<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_bottom_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JDOPermission.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../javax/jdo/spi/JDOImplHelper.html" title="class in javax.jdo.spi"><B>PREV CLASS</B></A>
+ <A HREF="../../../javax/jdo/spi/RegisterClassEvent.html" title="class in javax.jdo.spi"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../index.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="JDOPermission.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#methods_inherited_from_class_java.security.BasicPermission">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | METHOD</FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+Copyright © 2005 Apache Software Foundation. All Rights Reserved.
+</BODY>
+</HTML>
Added: incubator/jdo/site/docs/api11/apidocs/javax/jdo/spi/PersistenceCapable.ObjectIdFieldConsumer.html
URL: http://svn.apache.org/viewcvs/incubator/jdo/site/docs/api11/apidocs/javax/jdo/spi/PersistenceCapable.ObjectIdFieldConsumer.html?rev=321004&view=auto
==============================================================================
--- incubator/jdo/site/docs/api11/apidocs/javax/jdo/spi/PersistenceCapable.ObjectIdFieldConsumer.html (added)
+++ incubator/jdo/site/docs/api11/apidocs/javax/jdo/spi/PersistenceCapable.ObjectIdFieldConsumer.html Thu Oct 13 22:05:52 2005
@@ -0,0 +1,447 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.4.2_09) on Thu Oct 13 20:55:52 PDT 2005 -->
+<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<TITLE>
+PersistenceCapable.ObjectIdFieldConsumer (JDO1 API 1.1)
+</TITLE>
+
+<META NAME="keywords" CONTENT="javax.jdo.spi.PersistenceCapable.ObjectIdFieldConsumer interface">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="PersistenceCapable.ObjectIdFieldConsumer (JDO1 API 1.1)";
+}
+</SCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+
+
+<!-- ========= START OF TOP NAVBAR ======= -->
+<A NAME="navbar_top"><!-- --></A>
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PersistenceCapable.ObjectIdFieldConsumer.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../javax/jdo/spi/PersistenceCapable.html" title="interface in javax.jdo.spi"><B>PREV CLASS</B></A>
+ <A HREF="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldManager.html" title="interface in javax.jdo.spi"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../index.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="PersistenceCapable.ObjectIdFieldConsumer.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+javax.jdo.spi</FONT>
+<BR>
+Interface PersistenceCapable.ObjectIdFieldConsumer</H2>
+<DL>
+<DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldManager.html" title="interface in javax.jdo.spi">PersistenceCapable.ObjectIdFieldManager</A></DD>
+</DL>
+<DL>
+<DT><B>Enclosing interface:</B><DD><A HREF="../../../javax/jdo/spi/PersistenceCapable.html" title="interface in javax.jdo.spi">PersistenceCapable</A></DD>
+</DL>
+<HR>
+<DL>
+<DT>public static interface <B>PersistenceCapable.ObjectIdFieldConsumer</B></DL>
+
+<P>
+This interface is used to store fields from the Object id instance. It is used
+ by the method copyKeyFieldsFromObjectId. When the method is called, the
+ generated code calls the instance of ObjectIdFieldManager for each field in
+ the object id.
+<P>
+
+<P>
+<HR>
+
+<P>
+<!-- ======== NESTED CLASS SUMMARY ======== -->
+
+
+<!-- =========== FIELD SUMMARY =========== -->
+
+
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+
+
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TD COLSPAN=2><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldConsumer.html#storeBooleanField(int, boolean)">storeBooleanField</A></B>(int fieldNumber,
+ boolean value)</CODE>
+
+<BR>
+ Store one field into the field manager.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldConsumer.html#storeByteField(int, byte)">storeByteField</A></B>(int fieldNumber,
+ byte value)</CODE>
+
+<BR>
+ Store one field into the field manager.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldConsumer.html#storeCharField(int, char)">storeCharField</A></B>(int fieldNumber,
+ char value)</CODE>
+
+<BR>
+ Store one field into the field manager.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldConsumer.html#storeDoubleField(int, double)">storeDoubleField</A></B>(int fieldNumber,
+ double value)</CODE>
+
+<BR>
+ Store one field into the field manager.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldConsumer.html#storeFloatField(int, float)">storeFloatField</A></B>(int fieldNumber,
+ float value)</CODE>
+
+<BR>
+ Store one field into the field manager.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldConsumer.html#storeIntField(int, int)">storeIntField</A></B>(int fieldNumber,
+ int value)</CODE>
+
+<BR>
+ Store one field into the field manager.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldConsumer.html#storeLongField(int, long)">storeLongField</A></B>(int fieldNumber,
+ long value)</CODE>
+
+<BR>
+ Store one field into the field manager.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldConsumer.html#storeObjectField(int, java.lang.Object)">storeObjectField</A></B>(int fieldNumber,
+ java.lang.Object value)</CODE>
+
+<BR>
+ Store one field into the field manager.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldConsumer.html#storeShortField(int, short)">storeShortField</A></B>(int fieldNumber,
+ short value)</CODE>
+
+<BR>
+ Store one field into the field manager.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldConsumer.html#storeStringField(int, java.lang.String)">storeStringField</A></B>(int fieldNumber,
+ java.lang.String value)</CODE>
+
+<BR>
+ Store one field into the field manager.</TD>
+</TR>
+</TABLE>
+
+<P>
+
+<!-- ============ FIELD DETAIL =========== -->
+
+
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TD COLSPAN=1><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TD>
+</TR>
+</TABLE>
+
+<A NAME="storeBooleanField(int, boolean)"><!-- --></A><H3>
+storeBooleanField</H3>
+<PRE>
+public void <B>storeBooleanField</B>(int fieldNumber,
+ boolean value)</PRE>
+<DL>
+<DD>Store one field into the field manager. This field was retrieved from
+ the field of the ObjectId.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>fieldNumber</CODE> - the field number of the key field.<DD><CODE>value</CODE> - the value of the field from the ObjectId.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="storeCharField(int, char)"><!-- --></A><H3>
+storeCharField</H3>
+<PRE>
+public void <B>storeCharField</B>(int fieldNumber,
+ char value)</PRE>
+<DL>
+<DD>Store one field into the field manager. This field was retrieved from
+ the field of the ObjectId.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>fieldNumber</CODE> - the field number of the key field.<DD><CODE>value</CODE> - the value of the field from the ObjectId.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="storeByteField(int, byte)"><!-- --></A><H3>
+storeByteField</H3>
+<PRE>
+public void <B>storeByteField</B>(int fieldNumber,
+ byte value)</PRE>
+<DL>
+<DD>Store one field into the field manager. This field was retrieved from
+ the field of the ObjectId.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>fieldNumber</CODE> - the field number of the key field.<DD><CODE>value</CODE> - the value of the field from the ObjectId.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="storeShortField(int, short)"><!-- --></A><H3>
+storeShortField</H3>
+<PRE>
+public void <B>storeShortField</B>(int fieldNumber,
+ short value)</PRE>
+<DL>
+<DD>Store one field into the field manager. This field was retrieved from
+ the field of the ObjectId.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>fieldNumber</CODE> - the field number of the key field.<DD><CODE>value</CODE> - the value of the field from the ObjectId.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="storeIntField(int, int)"><!-- --></A><H3>
+storeIntField</H3>
+<PRE>
+public void <B>storeIntField</B>(int fieldNumber,
+ int value)</PRE>
+<DL>
+<DD>Store one field into the field manager. This field was retrieved from
+ the field of the ObjectId.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>fieldNumber</CODE> - the field number of the key field.<DD><CODE>value</CODE> - the value of the field from the ObjectId.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="storeLongField(int, long)"><!-- --></A><H3>
+storeLongField</H3>
+<PRE>
+public void <B>storeLongField</B>(int fieldNumber,
+ long value)</PRE>
+<DL>
+<DD>Store one field into the field manager. This field was retrieved from
+ the field of the ObjectId.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>fieldNumber</CODE> - the field number of the key field.<DD><CODE>value</CODE> - the value of the field from the ObjectId.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="storeFloatField(int, float)"><!-- --></A><H3>
+storeFloatField</H3>
+<PRE>
+public void <B>storeFloatField</B>(int fieldNumber,
+ float value)</PRE>
+<DL>
+<DD>Store one field into the field manager. This field was retrieved from
+ the field of the ObjectId.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>fieldNumber</CODE> - the field number of the key field.<DD><CODE>value</CODE> - the value of the field from the ObjectId.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="storeDoubleField(int, double)"><!-- --></A><H3>
+storeDoubleField</H3>
+<PRE>
+public void <B>storeDoubleField</B>(int fieldNumber,
+ double value)</PRE>
+<DL>
+<DD>Store one field into the field manager. This field was retrieved from
+ the field of the ObjectId.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>fieldNumber</CODE> - the field number of the key field.<DD><CODE>value</CODE> - the value of the field from the ObjectId.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="storeStringField(int, java.lang.String)"><!-- --></A><H3>
+storeStringField</H3>
+<PRE>
+public void <B>storeStringField</B>(int fieldNumber,
+ java.lang.String value)</PRE>
+<DL>
+<DD>Store one field into the field manager. This field was retrieved from
+ the field of the ObjectId.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>fieldNumber</CODE> - the field number of the key field.<DD><CODE>value</CODE> - the value of the field from the ObjectId.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="storeObjectField(int, java.lang.Object)"><!-- --></A><H3>
+storeObjectField</H3>
+<PRE>
+public void <B>storeObjectField</B>(int fieldNumber,
+ java.lang.Object value)</PRE>
+<DL>
+<DD>Store one field into the field manager. This field was retrieved from
+ the field of the ObjectId.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>fieldNumber</CODE> - the field number of the key field.<DD><CODE>value</CODE> - the value of the field from the ObjectId.</DL>
+</DD>
+</DL>
+<!-- ========= END OF CLASS DATA ========= -->
+<HR>
+
+
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<A NAME="navbar_bottom"><!-- --></A>
+<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_bottom_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PersistenceCapable.ObjectIdFieldConsumer.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../javax/jdo/spi/PersistenceCapable.html" title="interface in javax.jdo.spi"><B>PREV CLASS</B></A>
+ <A HREF="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldManager.html" title="interface in javax.jdo.spi"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../index.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="PersistenceCapable.ObjectIdFieldConsumer.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+Copyright © 2005 Apache Software Foundation. All Rights Reserved.
+</BODY>
+</HTML>