| <!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.6.0_05-ea) on Fri Oct 10 11:21:06 PDT 2008 --> |
| <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| <TITLE> |
| SingleFieldIdentity (JDO2 API 2.2) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2008-10-10"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SingleFieldIdentity (JDO2 API 2.2)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= 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=2 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/SingleFieldIdentity.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/identity/ShortIdentity.html" title="class in javax.jdo.identity"><B>PREV CLASS</B></A> |
| <A HREF="../../../javax/jdo/identity/StringIdentity.html" title="class in javax.jdo.identity"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../index.html?javax/jdo/identity/SingleFieldIdentity.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="SingleFieldIdentity.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="#method_summary">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> | <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.identity</FONT> |
| <BR> |
| Class SingleFieldIdentity</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>javax.jdo.identity.SingleFieldIdentity</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD>java.io.Externalizable, java.io.Serializable, java.lang.Comparable</DD> |
| </DL> |
| <DL> |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../javax/jdo/identity/ByteIdentity.html" title="class in javax.jdo.identity">ByteIdentity</A>, <A HREF="../../../javax/jdo/identity/CharIdentity.html" title="class in javax.jdo.identity">CharIdentity</A>, <A HREF="../../../javax/jdo/identity/IntIdentity.html" title="class in javax.jdo.identity">IntIdentity</A>, <A HREF="../../../javax/jdo/identity/LongIdentity.html" title="class in javax.jdo.identity">LongIdentity</A>, <A HREF="../../../javax/jdo/identity/ObjectIdentity.html" title="class in javax.jdo.identity">ObjectIdentity</A>, <A HREF="../../../javax/jdo/identity/ShortIdentity.html" title="class in javax.jdo.identity">ShortIdentity</A>, <A HREF="../../../javax/jdo/identity/StringIdentity.html" title="class in javax.jdo.identity">StringIdentity</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public abstract class <B>SingleFieldIdentity</B><DT>extends java.lang.Object<DT>implements java.io.Externalizable, java.lang.Comparable</DL> |
| </PRE> |
| |
| <P> |
| This class is the abstract base class for all single field identity |
| classes. A common case of application identity uses exactly one |
| persistent field in the class to represent identity. In this case, |
| the application can use a standard JDO class instead of creating |
| a new user-defined class for the purpose. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Version:</B></DT> |
| <DD>2.0</DD> |
| <DT><B>See Also:</B><DD><A HREF="../../../serialized-form.html#javax.jdo.identity.SingleFieldIdentity">Serialized Form</A></DL> |
| <HR> |
| |
| <P> |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/identity/SingleFieldIdentity.html#hashCode">hashCode</A></B></CODE> |
| |
| <BR> |
| The hashCode.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.Object</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/identity/SingleFieldIdentity.html#keyAsObject">keyAsObject</A></B></CODE> |
| |
| <BR> |
| The key as an Object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected static <A HREF="../../../javax/jdo/spi/I18NHelper.html" title="class in javax.jdo.spi">I18NHelper</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/identity/SingleFieldIdentity.html#msg">msg</A></B></CODE> |
| |
| <BR> |
| The Internationalization message helper.</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"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> </CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/identity/SingleFieldIdentity.html#SingleFieldIdentity()">SingleFieldIdentity</A></B>()</CODE> |
| |
| <BR> |
| Constructor only for Externalizable.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected </CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/identity/SingleFieldIdentity.html#SingleFieldIdentity(java.lang.Class)">SingleFieldIdentity</A></B>(java.lang.Class pcClass)</CODE> |
| |
| <BR> |
| Constructor with target class.</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/identity/SingleFieldIdentity.html#assertKeyNotNull(java.lang.Object)">assertKeyNotNull</A></B>(java.lang.Object key)</CODE> |
| |
| <BR> |
| Assert that the key is not null.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/identity/SingleFieldIdentity.html#compare(javax.jdo.identity.SingleFieldIdentity)">compare</A></B>(<A HREF="../../../javax/jdo/identity/SingleFieldIdentity.html" title="class in javax.jdo.identity">SingleFieldIdentity</A> o)</CODE> |
| |
| <BR> |
| Determine the ordering of identity objects.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.Object</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/identity/SingleFieldIdentity.html#createKeyAsObject()">createKeyAsObject</A></B>()</CODE> |
| |
| <BR> |
| Create the key as an Object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/identity/SingleFieldIdentity.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object obj)</CODE> |
| |
| <BR> |
| Check the class and class name and object type.</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/identity/SingleFieldIdentity.html#getKeyAsObject()">getKeyAsObject</A></B>()</CODE> |
| |
| <BR> |
| Return the key as an Object.</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/identity/SingleFieldIdentity.html#getTargetClass()">getTargetClass</A></B>()</CODE> |
| |
| <BR> |
| Return the target 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/identity/SingleFieldIdentity.html#getTargetClassName()">getTargetClassName</A></B>()</CODE> |
| |
| <BR> |
| Return the target class name.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/identity/SingleFieldIdentity.html#hashClassName()">hashClassName</A></B>()</CODE> |
| |
| <BR> |
| Return the hash code of the class name.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/identity/SingleFieldIdentity.html#hashCode()">hashCode</A></B>()</CODE> |
| |
| <BR> |
| Return the cached hash code.</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/identity/SingleFieldIdentity.html#readExternal(java.io.ObjectInput)">readExternal</A></B>(java.io.ObjectInput in)</CODE> |
| |
| <BR> |
| Read from the input stream.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/identity/SingleFieldIdentity.html#setKeyAsObject(java.lang.Object)">setKeyAsObject</A></B>(java.lang.Object key)</CODE> |
| |
| <BR> |
| Set the given key as the key for this instance.</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/identity/SingleFieldIdentity.html#writeExternal(java.io.ObjectOutput)">writeExternal</A></B>(java.io.ObjectOutput out)</CODE> |
| |
| <BR> |
| Write to the output stream.</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"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait</CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Comparable"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from interface java.lang.Comparable</B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>compareTo</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"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Field Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="msg"><!-- --></A><H3> |
| msg</H3> |
| <PRE> |
| protected static <A HREF="../../../javax/jdo/spi/I18NHelper.html" title="class in javax.jdo.spi">I18NHelper</A> <B>msg</B></PRE> |
| <DL> |
| <DD>The Internationalization message helper. |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="hashCode"><!-- --></A><H3> |
| hashCode</H3> |
| <PRE> |
| protected int <B>hashCode</B></PRE> |
| <DL> |
| <DD>The hashCode. |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="keyAsObject"><!-- --></A><H3> |
| keyAsObject</H3> |
| <PRE> |
| protected java.lang.Object <B>keyAsObject</B></PRE> |
| <DL> |
| <DD>The key as an Object. |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="SingleFieldIdentity(java.lang.Class)"><!-- --></A><H3> |
| SingleFieldIdentity</H3> |
| <PRE> |
| protected <B>SingleFieldIdentity</B>(java.lang.Class pcClass)</PRE> |
| <DL> |
| <DD>Constructor with target class. |
| <P> |
| <DL> |
| <DT><B>Parameters:</B><DD><CODE>pcClass</CODE> - the class of the target<DT><B>Since:</B></DT> |
| <DD>2.0</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="SingleFieldIdentity()"><!-- --></A><H3> |
| SingleFieldIdentity</H3> |
| <PRE> |
| public <B>SingleFieldIdentity</B>()</PRE> |
| <DL> |
| <DD>Constructor only for Externalizable. |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>2.0</DD> |
| </DL> |
| </DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="setKeyAsObject(java.lang.Object)"><!-- --></A><H3> |
| setKeyAsObject</H3> |
| <PRE> |
| protected void <B>setKeyAsObject</B>(java.lang.Object key)</PRE> |
| <DL> |
| <DD>Set the given key as the key for this instance. |
| Compute the hash code for the instance. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>2.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="assertKeyNotNull(java.lang.Object)"><!-- --></A><H3> |
| assertKeyNotNull</H3> |
| <PRE> |
| protected void <B>assertKeyNotNull</B>(java.lang.Object key)</PRE> |
| <DL> |
| <DD>Assert that the key is not null. Throw a JDONullIdentityException |
| if the given key is null. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>2.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getTargetClass()"><!-- --></A><H3> |
| getTargetClass</H3> |
| <PRE> |
| public java.lang.Class <B>getTargetClass</B>()</PRE> |
| <DL> |
| <DD>Return the target class. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the target class.<DT><B>Since:</B></DT> |
| <DD>2.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getTargetClassName()"><!-- --></A><H3> |
| getTargetClassName</H3> |
| <PRE> |
| public java.lang.String <B>getTargetClassName</B>()</PRE> |
| <DL> |
| <DD>Return the target class name. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the target class name.<DT><B>Since:</B></DT> |
| <DD>2.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getKeyAsObject()"><!-- --></A><H3> |
| getKeyAsObject</H3> |
| <PRE> |
| public java.lang.Object <B>getKeyAsObject</B>()</PRE> |
| <DL> |
| <DD>Return the key as an Object. The method is synchronized to avoid |
| race conditions in multi-threaded environments. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the key as an Object.<DT><B>Since:</B></DT> |
| <DD>2.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createKeyAsObject()"><!-- --></A><H3> |
| createKeyAsObject</H3> |
| <PRE> |
| protected java.lang.Object <B>createKeyAsObject</B>()</PRE> |
| <DL> |
| <DD>Create the key as an Object. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the key as an Object;<DT><B>Since:</B></DT> |
| <DD>2.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="equals(java.lang.Object)"><!-- --></A><H3> |
| equals</H3> |
| <PRE> |
| public boolean <B>equals</B>(java.lang.Object obj)</PRE> |
| <DL> |
| <DD>Check the class and class name and object type. If restored |
| from serialization, class will be null so compare class name. |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE>equals</CODE> in class <CODE>java.lang.Object</CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>obj</CODE> - the other object |
| <DT><B>Returns:</B><DD>true if the class or class name is the same</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="hashClassName()"><!-- --></A><H3> |
| hashClassName</H3> |
| <PRE> |
| protected int <B>hashClassName</B>()</PRE> |
| <DL> |
| <DD>Return the hash code of the class name. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the hash code of the class name<DT><B>Since:</B></DT> |
| <DD>2.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="hashCode()"><!-- --></A><H3> |
| hashCode</H3> |
| <PRE> |
| public int <B>hashCode</B>()</PRE> |
| <DL> |
| <DD>Return the cached hash code. |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE>hashCode</CODE> in class <CODE>java.lang.Object</CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the cached hash code.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="writeExternal(java.io.ObjectOutput)"><!-- --></A><H3> |
| writeExternal</H3> |
| <PRE> |
| public void <B>writeExternal</B>(java.io.ObjectOutput out) |
| throws java.io.IOException</PRE> |
| <DL> |
| <DD>Write to the output stream. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE>writeExternal</CODE> in interface <CODE>java.io.Externalizable</CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>out</CODE> - the stream |
| <DT><B>Throws:</B> |
| <DD><CODE>java.io.IOException</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="readExternal(java.io.ObjectInput)"><!-- --></A><H3> |
| readExternal</H3> |
| <PRE> |
| public void <B>readExternal</B>(java.io.ObjectInput in) |
| throws java.io.IOException, |
| java.lang.ClassNotFoundException</PRE> |
| <DL> |
| <DD>Read from the input stream. |
| Creates a new instance with the target class name set |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE>readExternal</CODE> in interface <CODE>java.io.Externalizable</CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE>java.io.IOException</CODE> |
| <DD><CODE>java.lang.ClassNotFoundException</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="compare(javax.jdo.identity.SingleFieldIdentity)"><!-- --></A><H3> |
| compare</H3> |
| <PRE> |
| protected int <B>compare</B>(<A HREF="../../../javax/jdo/identity/SingleFieldIdentity.html" title="class in javax.jdo.identity">SingleFieldIdentity</A> o)</PRE> |
| <DL> |
| <DD>Determine the ordering of identity objects. Only the class name |
| is compared. This method is only used by subclasses. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>o</CODE> - Other identity |
| <DT><B>Returns:</B><DD>The relative ordering between the objects<DT><B>Since:</B></DT> |
| <DD>2.2</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=2 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/SingleFieldIdentity.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/identity/ShortIdentity.html" title="class in javax.jdo.identity"><B>PREV CLASS</B></A> |
| <A HREF="../../../javax/jdo/identity/StringIdentity.html" title="class in javax.jdo.identity"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../index.html?javax/jdo/identity/SingleFieldIdentity.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="SingleFieldIdentity.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="#method_summary">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> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2005-2008 Apache Software Foundation. All Rights Reserved. |
| </BODY> |
| </HTML> |
