1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!--NewPage--> 3<HTML> 4<HEAD> 5<!-- Generated by javadoc (build 1.6.0_03) on Mon Apr 12 16:25:51 EDT 2010 --> 6<TITLE> 7Deleter (Oracle - Berkeley DB Java API) 8</TITLE> 9 10<META NAME="date" CONTENT="2010-04-12"> 11 12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../style.css" TITLE="Style"> 13 14<SCRIPT type="text/javascript"> 15function windowTitle() 16{ 17 if (location.href.indexOf('is-external=true') == -1) { 18 parent.document.title="Deleter (Oracle - Berkeley DB Java API)"; 19 } 20} 21</SCRIPT> 22<NOSCRIPT> 23</NOSCRIPT> 24 25</HEAD> 26 27<BODY BGCOLOR="white" onload="windowTitle();"> 28<HR> 29 30 31<!-- ========= START OF TOP NAVBAR ======= --> 32<A NAME="navbar_top"><!-- --></A> 33<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 34<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 35<TR> 36<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 37<A NAME="navbar_top_firstrow"><!-- --></A> 38<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 39 <TR ALIGN="center" VALIGN="top"> 40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Deleter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 48 </TR> 49</TABLE> 50</TD> 51<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 52<b>Berkeley DB</b><br><font size="-1"> version 4.8.30</font></EM> 53</TD> 54</TR> 55 56<TR> 57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 58 <A HREF="../../../../com/sleepycat/persist/evolve/DeletedClassException.html" title="class in com.sleepycat.persist.evolve"><B>PREV CLASS</B></A> 59 <A HREF="../../../../com/sleepycat/persist/evolve/EntityConverter.html" title="class in com.sleepycat.persist.evolve"><B>NEXT CLASS</B></A></FONT></TD> 60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 61 <A HREF="../../../../index.html?com/sleepycat/persist/evolve/Deleter.html" target="_top"><B>FRAMES</B></A> 62 <A HREF="Deleter.html" target="_top"><B>NO FRAMES</B></A> 63 <SCRIPT type="text/javascript"> 64 <!-- 65 if(window==top) { 66 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 67 } 68 //--> 69</SCRIPT> 70<NOSCRIPT> 71 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 72</NOSCRIPT> 73 74 75</FONT></TD> 76</TR> 77<TR> 78<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 79 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 81DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 82</TR> 83</TABLE> 84<A NAME="skip-navbar_top"></A> 85<!-- ========= END OF TOP NAVBAR ========= --> 86 87<HR> 88<!-- ======== START OF CLASS DATA ======== --> 89<H2> 90<FONT SIZE="-1"> 91com.sleepycat.persist.evolve</FONT> 92<BR> 93Class Deleter</H2> 94<PRE> 95<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> 96 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../com/sleepycat/persist/evolve/Mutation.html" title="class in com.sleepycat.persist.evolve">com.sleepycat.persist.evolve.Mutation</A> 97 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.persist.evolve.Deleter</B> 98</PRE> 99<DL> 100<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A></DD> 101</DL> 102<HR> 103<DL> 104<DT><PRE>public class <B>Deleter</B><DT>extends <A HREF="../../../../com/sleepycat/persist/evolve/Mutation.html" title="class in com.sleepycat.persist.evolve">Mutation</A></DL> 105</PRE> 106 107<P> 108A mutation for deleting an entity class or field. 109 110 <p><strong>WARNING:</strong> The data for the deleted class or field will be 111 destroyed and will be recoverable only by restoring from backup. If you 112 wish to convert the instance data to a different type or format, use a 113 <A HREF="../../../../com/sleepycat/persist/evolve/Conversion.html" title="interface in com.sleepycat.persist.evolve"><CODE>Conversion</CODE></A> mutation instead.</p> 114 115 <p>For example, to delete a field:</p> 116 117 <pre class="code"> 118 package my.package; 119 120 // The old class. Version 0 is implied. 121 // 122 @Entity 123 class Person { 124 String name; 125 String favoriteColors; 126 } 127 128 // The new class. A new version number must be assigned. 129 // 130 @Entity(version=1) 131 class Person { 132 String name; 133 } 134 135 // Add the mutation for deleting a field. 136 // 137 Mutations mutations = new Mutations(); 138 139 mutations.addDeleter(new Deleter(Person.class.getName(), 0, 140 "favoriteColors"); 141 142 // Configure the mutations as described <A HREF="../../../../com/sleepycat/persist/evolve/Mutations.html" title="class in com.sleepycat.persist.evolve"><CODE>here</CODE></A>.</pre> 143 144 <p>To delete an entity class:</p> 145 146 <pre class="code"> 147 package my.package; 148 149 // The old class. Version 0 is implied. 150 // 151 @Entity 152 class Statistics { 153 ... 154 } 155 156 // Add the mutation for deleting a class. 157 // 158 Mutations mutations = new Mutations(); 159 160 mutations.addDeleter(new Deleter("my.package.Statistics", 0)); 161 162 // Configure the mutations as described <A HREF="../../../../com/sleepycat/persist/evolve/Mutations.html" title="class in com.sleepycat.persist.evolve"><CODE>here</CODE></A>.</pre> 163<P> 164 165<P> 166<DL> 167<DT><B>See Also:</B><DD><A HREF="../../../../com/sleepycat/persist/evolve/package-summary.html"><CODE>Class Evolution</CODE></A>, 168<A HREF="../../../../serialized-form.html#com.sleepycat.persist.evolve.Deleter">Serialized Form</A></DL> 169<HR> 170 171<P> 172 173<!-- ======== CONSTRUCTOR SUMMARY ======== --> 174 175<A NAME="constructor_summary"><!-- --></A> 176<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 177<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 178<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 179<B>Constructor Summary</B></FONT></TH> 180</TR> 181<TR BGCOLOR="white" CLASS="TableRowColor"> 182<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/evolve/Deleter.html#Deleter(java.lang.String, int)">Deleter</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> className, 183 int classVersion)</CODE> 184 185<BR> 186 Creates a mutation for deleting an entity class.</TD> 187</TR> 188<TR BGCOLOR="white" CLASS="TableRowColor"> 189<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/evolve/Deleter.html#Deleter(java.lang.String, int, java.lang.String)">Deleter</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> declaringClass, 190 int declaringClassVersion, 191 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fieldName)</CODE> 192 193<BR> 194 Creates a mutation for deleting the given field from all instances of 195 the given class version.</TD> 196</TR> 197</TABLE> 198 199<!-- ========== METHOD SUMMARY =========== --> 200 201<A NAME="method_summary"><!-- --></A> 202<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 203<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 204<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 205<B>Method Summary</B></FONT></TH> 206</TR> 207<TR BGCOLOR="white" CLASS="TableRowColor"> 208<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 209<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> 210<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/evolve/Deleter.html#toString()">toString</A></B>()</CODE> 211 212<BR> 213 </TD> 214</TR> 215</TABLE> 216 <A NAME="methods_inherited_from_class_com.sleepycat.persist.evolve.Mutation"><!-- --></A> 217<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 218<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 219<TH ALIGN="left"><B>Methods inherited from class com.sleepycat.persist.evolve.<A HREF="../../../../com/sleepycat/persist/evolve/Mutation.html" title="class in com.sleepycat.persist.evolve">Mutation</A></B></TH> 220</TR> 221<TR BGCOLOR="white" CLASS="TableRowColor"> 222<TD><CODE><A HREF="../../../../com/sleepycat/persist/evolve/Mutation.html#equals(java.lang.Object)">equals</A>, <A HREF="../../../../com/sleepycat/persist/evolve/Mutation.html#getClassName()">getClassName</A>, <A HREF="../../../../com/sleepycat/persist/evolve/Mutation.html#getClassVersion()">getClassVersion</A>, <A HREF="../../../../com/sleepycat/persist/evolve/Mutation.html#getFieldName()">getFieldName</A>, <A HREF="../../../../com/sleepycat/persist/evolve/Mutation.html#hashCode()">hashCode</A></CODE></TD> 223</TR> 224</TABLE> 225 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 226<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 227<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 228<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> 229</TR> 230<TR BGCOLOR="white" CLASS="TableRowColor"> 231<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> 232</TR> 233</TABLE> 234 235<P> 236 237<!-- ========= CONSTRUCTOR DETAIL ======== --> 238 239<A NAME="constructor_detail"><!-- --></A> 240<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 241<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 242<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 243<B>Constructor Detail</B></FONT></TH> 244</TR> 245</TABLE> 246 247<A NAME="Deleter(java.lang.String, int)"><!-- --></A><H3> 248Deleter</H3> 249<PRE> 250public <B>Deleter</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> className, 251 int classVersion)</PRE> 252<DL> 253<DD>Creates a mutation for deleting an entity class. 254<P> 255</DL> 256<HR> 257 258<A NAME="Deleter(java.lang.String, int, java.lang.String)"><!-- --></A><H3> 259Deleter</H3> 260<PRE> 261public <B>Deleter</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> declaringClass, 262 int declaringClassVersion, 263 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fieldName)</PRE> 264<DL> 265<DD>Creates a mutation for deleting the given field from all instances of 266 the given class version. 267<P> 268</DL> 269 270<!-- ============ METHOD DETAIL ========== --> 271 272<A NAME="method_detail"><!-- --></A> 273<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 274<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 275<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 276<B>Method Detail</B></FONT></TH> 277</TR> 278</TABLE> 279 280<A NAME="toString()"><!-- --></A><H3> 281toString</H3> 282<PRE> 283public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE> 284<DL> 285<DD><DL> 286<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/sleepycat/persist/evolve/Mutation.html#toString()">toString</A></CODE> in class <CODE><A HREF="../../../../com/sleepycat/persist/evolve/Mutation.html" title="class in com.sleepycat.persist.evolve">Mutation</A></CODE></DL> 287</DD> 288<DD><DL> 289</DL> 290</DD> 291</DL> 292<!-- ========= END OF CLASS DATA ========= --> 293<HR> 294 295 296<!-- ======= START OF BOTTOM NAVBAR ====== --> 297<A NAME="navbar_bottom"><!-- --></A> 298<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 299<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 300<TR> 301<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 302<A NAME="navbar_bottom_firstrow"><!-- --></A> 303<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 304 <TR ALIGN="center" VALIGN="top"> 305 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 306 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 307 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 308 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Deleter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 309 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 310 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 311 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 312 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 313 </TR> 314</TABLE> 315</TD> 316<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 317<b>Berkeley DB</b><br><font size="-1"> version 4.8.30</font></EM> 318</TD> 319</TR> 320 321<TR> 322<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 323 <A HREF="../../../../com/sleepycat/persist/evolve/DeletedClassException.html" title="class in com.sleepycat.persist.evolve"><B>PREV CLASS</B></A> 324 <A HREF="../../../../com/sleepycat/persist/evolve/EntityConverter.html" title="class in com.sleepycat.persist.evolve"><B>NEXT CLASS</B></A></FONT></TD> 325<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 326 <A HREF="../../../../index.html?com/sleepycat/persist/evolve/Deleter.html" target="_top"><B>FRAMES</B></A> 327 <A HREF="Deleter.html" target="_top"><B>NO FRAMES</B></A> 328 <SCRIPT type="text/javascript"> 329 <!-- 330 if(window==top) { 331 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 332 } 333 //--> 334</SCRIPT> 335<NOSCRIPT> 336 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 337</NOSCRIPT> 338 339 340</FONT></TD> 341</TR> 342<TR> 343<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 344 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 345<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 346DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 347</TR> 348</TABLE> 349<A NAME="skip-navbar_bottom"></A> 350<!-- ======== END OF BOTTOM NAVBAR ======= --> 351 352<HR> 353<font size=1>Copyright (c) 1996-2009 Oracle. All rights reserved.</font> 354</BODY> 355</HTML> 356