<!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_0) on Wed Dec 30 04:50:28 EST 2009 --> <TITLE> Enhanced </TITLE> <META NAME="date" CONTENT="2009-12-30"> <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="Enhanced"; } } </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="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="../../../../com/sleepycat/persist/impl/ConverterReader.html" title="class in com.sleepycat.persist.impl"><B>PREV CLASS</B></A> <A HREF="../../../../com/sleepycat/persist/impl/EnhancedAccessor.html" title="class in com.sleepycat.persist.impl"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?com/sleepycat/persist/impl/Enhanced.html" target="_top"><B>FRAMES</B></A> <A HREF="Enhanced.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"> com.sleepycat.persist.impl</FONT> <BR> Interface Enhanced</H2> <HR> <DL> <DT><PRE>public interface <B>Enhanced</B></DL> </PRE> <P> Interface implemented by a persistent class via bytecode enhancement. <p>See <CODE>Accessor</CODE> for method documentation. <A HREF="../../../../com/sleepycat/persist/impl/EnhancedAccessor.html" title="class in com.sleepycat.persist.impl"><CODE>EnhancedAccessor</CODE></A> implements Accessor and forwards all calls to methods in the Enhanced class.</p> <p>Each class that implements this interface (including its subclasses and superclasses except for Object) must also implement a static block that registers a prototype instance by calling EnhancedAccessor.registerPrototype. Other instances are created from the protype instance using <A HREF="../../../../com/sleepycat/persist/impl/Enhanced.html#bdbNewInstance()"><CODE>bdbNewInstance()</CODE></A>.</p> <pre>static { EnhancedAccessor.registerPrototype(new Xxx()); }</pre> <p>An example of the generated code for reading and writing fields is shown below.</p> <pre> private int f1; private String f2; private MyClass f3; public void bdbWriteNonKeyFields(EntityOutput output) { super.bdbWriteNonKeyFields(output); output.writeInt(f1); output.writeObject(f2, null); output.writeObject(f3, null); } public void bdbReadNonKeyFields(EntityInput input, int startField, int endField, int superLevel) { if (superLevel != 0) { super.bdbReadNonKeyFields(input, startField, endField, superLevel - 1); } if (superLevel <= 0) { switch (startField) { case 0: f1 = input.readInt(); if (endField == 0) break; case 1: f2 = (String) input.readObject(); if (endField == 1) break; case 2: f3 = (MyClass) input.readObject(); } } } </pre> <P> <P> <HR> <P> <!-- ========== 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> java.lang.Object</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/Enhanced.html#bdbGetField(java.lang.Object, int, int, boolean)">bdbGetField</A></B>(java.lang.Object o, int field, int superLevel, boolean isSecField)</CODE> <BR> </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="../../../../com/sleepycat/persist/impl/Enhanced.html#bdbIsPriKeyFieldNullOrZero()">bdbIsPriKeyFieldNullOrZero</A></B>()</CODE> <BR> Calls the super class method if this class does not contain the primary key field.</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="../../../../com/sleepycat/persist/impl/Enhanced.html#bdbNewArray(int)">bdbNewArray</A></B>(int len)</CODE> <BR> </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="../../../../com/sleepycat/persist/impl/Enhanced.html#bdbNewInstance()">bdbNewInstance</A></B>()</CODE> <BR> </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="../../../../com/sleepycat/persist/impl/Enhanced.html#bdbReadNonKeyFields(com.sleepycat.persist.impl.EntityInput, int, int, int)">bdbReadNonKeyFields</A></B>(<A HREF="../../../../com/sleepycat/persist/impl/EntityInput.html" title="interface in com.sleepycat.persist.impl">EntityInput</A> input, int startField, int endField, int superLevel)</CODE> <BR> </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="../../../../com/sleepycat/persist/impl/Enhanced.html#bdbReadPriKeyField(com.sleepycat.persist.impl.EntityInput, com.sleepycat.persist.impl.Format)">bdbReadPriKeyField</A></B>(<A HREF="../../../../com/sleepycat/persist/impl/EntityInput.html" title="interface in com.sleepycat.persist.impl">EntityInput</A> input, <A HREF="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</A> format)</CODE> <BR> Calls the super class method if this class does not contain the primary key field.</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="../../../../com/sleepycat/persist/impl/Enhanced.html#bdbReadSecKeyFields(com.sleepycat.persist.impl.EntityInput, int, int, int)">bdbReadSecKeyFields</A></B>(<A HREF="../../../../com/sleepycat/persist/impl/EntityInput.html" title="interface in com.sleepycat.persist.impl">EntityInput</A> input, int startField, int endField, int superLevel)</CODE> <BR> </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="../../../../com/sleepycat/persist/impl/Enhanced.html#bdbSetField(java.lang.Object, int, int, boolean, java.lang.Object)">bdbSetField</A></B>(java.lang.Object o, int field, int superLevel, boolean isSecField, java.lang.Object value)</CODE> <BR> </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="../../../../com/sleepycat/persist/impl/Enhanced.html#bdbWriteNonKeyFields(com.sleepycat.persist.impl.EntityOutput)">bdbWriteNonKeyFields</A></B>(<A HREF="../../../../com/sleepycat/persist/impl/EntityOutput.html" title="interface in com.sleepycat.persist.impl">EntityOutput</A> output)</CODE> <BR> </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="../../../../com/sleepycat/persist/impl/Enhanced.html#bdbWritePriKeyField(com.sleepycat.persist.impl.EntityOutput, com.sleepycat.persist.impl.Format)">bdbWritePriKeyField</A></B>(<A HREF="../../../../com/sleepycat/persist/impl/EntityOutput.html" title="interface in com.sleepycat.persist.impl">EntityOutput</A> output, <A HREF="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</A> format)</CODE> <BR> Calls the super class method if this class does not contain the primary key field.</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="../../../../com/sleepycat/persist/impl/Enhanced.html#bdbWriteSecKeyFields(com.sleepycat.persist.impl.EntityOutput)">bdbWriteSecKeyFields</A></B>(<A HREF="../../../../com/sleepycat/persist/impl/EntityOutput.html" title="interface in com.sleepycat.persist.impl">EntityOutput</A> output)</CODE> <BR> </TD> </TR> </TABLE> <P> <!-- ============ 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="bdbNewInstance()"><!-- --></A><H3> bdbNewInstance</H3> <PRE> java.lang.Object <B>bdbNewInstance</B>()</PRE> <DL> <DD><DL> <DT><B>See Also:</B><DD><CODE>Accessor.newInstance()</CODE></DL> </DD> </DL> <HR> <A NAME="bdbNewArray(int)"><!-- --></A><H3> bdbNewArray</H3> <PRE> java.lang.Object <B>bdbNewArray</B>(int len)</PRE> <DL> <DD><DL> <DT><B>See Also:</B><DD><CODE>Accessor.newArray(int)</CODE></DL> </DD> </DL> <HR> <A NAME="bdbIsPriKeyFieldNullOrZero()"><!-- --></A><H3> bdbIsPriKeyFieldNullOrZero</H3> <PRE> boolean <B>bdbIsPriKeyFieldNullOrZero</B>()</PRE> <DL> <DD>Calls the super class method if this class does not contain the primary key field. <P> <DD><DL> <DT><B>See Also:</B><DD><CODE>Accessor.isPriKeyFieldNullOrZero(java.lang.Object)</CODE></DL> </DD> </DL> <HR> <A NAME="bdbWritePriKeyField(com.sleepycat.persist.impl.EntityOutput, com.sleepycat.persist.impl.Format)"><!-- --></A><H3> bdbWritePriKeyField</H3> <PRE> void <B>bdbWritePriKeyField</B>(<A HREF="../../../../com/sleepycat/persist/impl/EntityOutput.html" title="interface in com.sleepycat.persist.impl">EntityOutput</A> output, <A HREF="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</A> format)</PRE> <DL> <DD>Calls the super class method if this class does not contain the primary key field. <P> <DD><DL> <DT><B>See Also:</B><DD><CODE>Accessor.writePriKeyField(java.lang.Object, com.sleepycat.persist.impl.EntityOutput)</CODE></DL> </DD> </DL> <HR> <A NAME="bdbReadPriKeyField(com.sleepycat.persist.impl.EntityInput, com.sleepycat.persist.impl.Format)"><!-- --></A><H3> bdbReadPriKeyField</H3> <PRE> void <B>bdbReadPriKeyField</B>(<A HREF="../../../../com/sleepycat/persist/impl/EntityInput.html" title="interface in com.sleepycat.persist.impl">EntityInput</A> input, <A HREF="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</A> format)</PRE> <DL> <DD>Calls the super class method if this class does not contain the primary key field. <P> <DD><DL> <DT><B>See Also:</B><DD><CODE>Accessor.readPriKeyField(java.lang.Object, com.sleepycat.persist.impl.EntityInput)</CODE></DL> </DD> </DL> <HR> <A NAME="bdbWriteSecKeyFields(com.sleepycat.persist.impl.EntityOutput)"><!-- --></A><H3> bdbWriteSecKeyFields</H3> <PRE> void <B>bdbWriteSecKeyFields</B>(<A HREF="../../../../com/sleepycat/persist/impl/EntityOutput.html" title="interface in com.sleepycat.persist.impl">EntityOutput</A> output)</PRE> <DL> <DD><DL> <DT><B>See Also:</B><DD><CODE>Accessor.writeSecKeyFields(java.lang.Object, com.sleepycat.persist.impl.EntityOutput)</CODE></DL> </DD> </DL> <HR> <A NAME="bdbReadSecKeyFields(com.sleepycat.persist.impl.EntityInput, int, int, int)"><!-- --></A><H3> bdbReadSecKeyFields</H3> <PRE> void <B>bdbReadSecKeyFields</B>(<A HREF="../../../../com/sleepycat/persist/impl/EntityInput.html" title="interface in com.sleepycat.persist.impl">EntityInput</A> input, int startField, int endField, int superLevel)</PRE> <DL> <DD><DL> <DT><B>See Also:</B><DD><CODE>Accessor.readSecKeyFields(java.lang.Object, com.sleepycat.persist.impl.EntityInput, int, int, int)</CODE></DL> </DD> </DL> <HR> <A NAME="bdbWriteNonKeyFields(com.sleepycat.persist.impl.EntityOutput)"><!-- --></A><H3> bdbWriteNonKeyFields</H3> <PRE> void <B>bdbWriteNonKeyFields</B>(<A HREF="../../../../com/sleepycat/persist/impl/EntityOutput.html" title="interface in com.sleepycat.persist.impl">EntityOutput</A> output)</PRE> <DL> <DD><DL> <DT><B>See Also:</B><DD><CODE>Accessor.writeNonKeyFields(java.lang.Object, com.sleepycat.persist.impl.EntityOutput)</CODE></DL> </DD> </DL> <HR> <A NAME="bdbReadNonKeyFields(com.sleepycat.persist.impl.EntityInput, int, int, int)"><!-- --></A><H3> bdbReadNonKeyFields</H3> <PRE> void <B>bdbReadNonKeyFields</B>(<A HREF="../../../../com/sleepycat/persist/impl/EntityInput.html" title="interface in com.sleepycat.persist.impl">EntityInput</A> input, int startField, int endField, int superLevel)</PRE> <DL> <DD><DL> <DT><B>See Also:</B><DD><CODE>Accessor.readNonKeyFields(java.lang.Object, com.sleepycat.persist.impl.EntityInput, int, int, int)</CODE></DL> </DD> </DL> <HR> <A NAME="bdbGetField(java.lang.Object, int, int, boolean)"><!-- --></A><H3> bdbGetField</H3> <PRE> java.lang.Object <B>bdbGetField</B>(java.lang.Object o, int field, int superLevel, boolean isSecField)</PRE> <DL> <DD><DL> <DT><B>See Also:</B><DD><CODE>Accessor.getField(java.lang.Object, int, int, boolean)</CODE></DL> </DD> </DL> <HR> <A NAME="bdbSetField(java.lang.Object, int, int, boolean, java.lang.Object)"><!-- --></A><H3> bdbSetField</H3> <PRE> void <B>bdbSetField</B>(java.lang.Object o, int field, int superLevel, boolean isSecField, java.lang.Object value)</PRE> <DL> <DD><DL> <DT><B>See Also:</B><DD><CODE>Accessor.setField(java.lang.Object, int, int, boolean, java.lang.Object)</CODE></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="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="../../../../com/sleepycat/persist/impl/ConverterReader.html" title="class in com.sleepycat.persist.impl"><B>PREV CLASS</B></A> <A HREF="../../../../com/sleepycat/persist/impl/EnhancedAccessor.html" title="class in com.sleepycat.persist.impl"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?com/sleepycat/persist/impl/Enhanced.html" target="_top"><B>FRAMES</B></A> <A HREF="Enhanced.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> </BODY> </HTML>