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