website/full_javadoc/compbio/engine/Cleaner.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
   2 <!--NewPage-->\r
   3 <HTML>\r
   4 <HEAD>\r
   5 <!-- Generated by javadoc (build 1.6.0_24) on Fri Aug 12 14:32:35 BST 2011 -->\r
   6 <TITLE>\r
   7 Cleaner\r
   8 </TITLE>\r
   9 \r
  10 <META NAME="date" CONTENT="2011-08-12">\r
  11 \r
  12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">\r
  13 \r
  14 <SCRIPT type="text/javascript">\r
  15 function windowTitle()\r
  16 {\r
  17     if (location.href.indexOf('is-external=true') == -1) {\r
  18         parent.document.title="Cleaner";\r
  19     }\r
  20 }\r
  21 </SCRIPT>\r
  22 <NOSCRIPT>\r
  23 </NOSCRIPT>\r
  24 \r
  25 </HEAD>\r
  26 \r
  27 <BODY BGCOLOR="white" onload="windowTitle();">\r
  28 <HR>\r
  29 \r
  30 \r
  31 <!-- ========= START OF TOP NAVBAR ======= -->\r
  32 <A NAME="navbar_top"><!-- --></A>\r
  33 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>\r
  34 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
  35 <TR>\r
  36 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
  37 <A NAME="navbar_top_firstrow"><!-- --></A>\r
  38 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
  39   <TR ALIGN="center" VALIGN="top">\r
  40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
  41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
  42   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
  43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Cleaner.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
  44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
  45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
  46   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
  47   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
  48   </TR>\r
  49 </TABLE>\r
  50 </TD>\r
  51 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
  52 </EM>\r
  53 </TD>\r
  54 </TR>\r
  55 \r
  56 <TR>\r
  57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
  58 &nbsp;<A HREF="../../compbio/engine/AsyncExecutor.html" title="interface in compbio.engine"><B>PREV CLASS</B></A>&nbsp;\r
  59 &nbsp;<A HREF="../../compbio/engine/ClusterJobId.html" title="class in compbio.engine"><B>NEXT CLASS</B></A></FONT></TD>\r
  60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
  61   <A HREF="../../index.html?compbio/engine/Cleaner.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
  62 &nbsp;<A HREF="Cleaner.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
  63 &nbsp;<SCRIPT type="text/javascript">\r
  64   <!--\r
  65   if(window==top) {\r
  66     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
  67   }\r
  68   //-->\r
  69 </SCRIPT>\r
  70 <NOSCRIPT>\r
  71   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
  72 </NOSCRIPT>\r
  73 \r
  74 \r
  75 </FONT></TD>\r
  76 </TR>\r
  77 <TR>\r
  78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
  79   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
  80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
  81 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
  82 </TR>\r
  83 </TABLE>\r
  84 <A NAME="skip-navbar_top"></A>\r
  85 <!-- ========= END OF TOP NAVBAR ========= -->\r
  86 \r
  87 <HR>\r
  88 <!-- ======== START OF CLASS DATA ======== -->\r
  89 <H2>\r
  90 <FONT SIZE="-1">\r
  91 compbio.engine</FONT>\r
  92 <BR>\r
  93 Class Cleaner</H2>\r
  94 <PRE>\r
  95 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>\r
  96   <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>compbio.engine.Cleaner</B>\r
  97 </PRE>\r
  98 <HR>\r
  99 <B>Deprecated.</B>\r
 100 <P>\r
 101 <DL>\r
 102 <DT><PRE><FONT SIZE="-1"><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</A>\r
 103 </FONT>public class <B>Cleaner</B><DT>extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL>\r
 104 </PRE>\r
 105 \r
 106 <P>\r
 107 <HR>\r
 108 \r
 109 <P>\r
 110 \r
 111 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
 112 \r
 113 <A NAME="constructor_summary"><!-- --></A>\r
 114 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 115 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 116 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 117 <B>Constructor Summary</B></FONT></TH>\r
 118 </TR>\r
 119 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 120 <TD><CODE><B><A HREF="../../compbio/engine/Cleaner.html#Cleaner()">Cleaner</A></B>()</CODE>\r
 121 \r
 122 <BR>\r
 123 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;&nbsp;</TD>\r
 124 </TR>\r
 125 </TABLE>\r
 126 &nbsp;\r
 127 <!-- ========== METHOD SUMMARY =========== -->\r
 128 \r
 129 <A NAME="method_summary"><!-- --></A>\r
 130 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 131 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 132 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 133 <B>Method Summary</B></FONT></TH>\r
 134 </TR>\r
 135 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 136 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 137 <CODE>static&nbsp;boolean</CODE></FONT></TD>\r
 138 <TD><CODE><B><A HREF="../../compbio/engine/Cleaner.html#deleteAllFiles(java.lang.String)">deleteAllFiles</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;directory)</CODE>\r
 139 \r
 140 <BR>\r
 141 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;&nbsp;</TD>\r
 142 </TR>\r
 143 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 144 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 145 <CODE>static&nbsp;boolean</CODE></FONT></TD>\r
 146 <TD><CODE><B><A HREF="../../compbio/engine/Cleaner.html#deleteFiles(compbio.engine.client.ConfiguredExecutable)">deleteFiles</A></B>(<A HREF="../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A>&lt;?&gt;&nbsp;exec)</CODE>\r
 147 \r
 148 <BR>\r
 149 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;This method returns true if all files specified by List files were
 150  successfully removed or there was no files to remove (files list was
 151  empty)</TD>\r
 152 </TR>\r
 153 </TABLE>\r
 154 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
 155 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 156 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 157 <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>\r
 158 </TR>\r
 159 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 160 <TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/javase/6/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/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/javase/6/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/javase/6/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/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/javase/6/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/javase/6/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/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>\r
 161 </TR>\r
 162 </TABLE>\r
 163 &nbsp;\r
 164 <P>\r
 165 \r
 166 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
 167 \r
 168 <A NAME="constructor_detail"><!-- --></A>\r
 169 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 170 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 171 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 172 <B>Constructor Detail</B></FONT></TH>\r
 173 </TR>\r
 174 </TABLE>\r
 175 \r
 176 <A NAME="Cleaner()"><!-- --></A><H3>\r
 177 Cleaner</H3>\r
 178 <PRE>\r
 179 public <B>Cleaner</B>()</PRE>\r
 180 <DL>\r
 181 <DD><B>Deprecated.</B>&nbsp;</DL>\r
 182 \r
 183 <!-- ============ METHOD DETAIL ========== -->\r
 184 \r
 185 <A NAME="method_detail"><!-- --></A>\r
 186 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 187 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 188 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 189 <B>Method Detail</B></FONT></TH>\r
 190 </TR>\r
 191 </TABLE>\r
 192 \r
 193 <A NAME="deleteFiles(compbio.engine.client.ConfiguredExecutable)"><!-- --></A><H3>\r
 194 deleteFiles</H3>\r
 195 <PRE>\r
 196 public static boolean <B>deleteFiles</B>(<A HREF="../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A>&lt;?&gt;&nbsp;exec)</PRE>\r
 197 <DL>\r
 198 <DD><B>Deprecated.</B>&nbsp;<DD>This method returns true if all files specified by List files were
 199  successfully removed or there was no files to remove (files list was
 200  empty)\r
 201 <P>\r
 202 <DD><DL>\r
 203 <DT><B>Parameters:</B><DD><CODE>workDirectory</CODE> - <DD><CODE>files</CODE> - \r
 204 <DT><B>Returns:</B><DD>This method returns true if all files specified by List files
 205          were successfully removed, false otherwise</DL>\r
 206 </DD>\r
 207 </DL>\r
 208 <HR>\r
 209 \r
 210 <A NAME="deleteAllFiles(java.lang.String)"><!-- --></A><H3>\r
 211 deleteAllFiles</H3>\r
 212 <PRE>\r
 213 public static boolean <B>deleteAllFiles</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;directory)</PRE>\r
 214 <DL>\r
 215 <DD><B>Deprecated.</B>&nbsp;<DD><DL>\r
 216 </DL>\r
 217 </DD>\r
 218 </DL>\r
 219 <!-- ========= END OF CLASS DATA ========= -->\r
 220 <HR>\r
 221 \r
 222 \r
 223 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 224 <A NAME="navbar_bottom"><!-- --></A>\r
 225 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
 226 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 227 <TR>\r
 228 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 229 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
 230 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 231   <TR ALIGN="center" VALIGN="top">\r
 232   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 233   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 234   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 235   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Cleaner.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
 236   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 237   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 238   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 239   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 240   </TR>\r
 241 </TABLE>\r
 242 </TD>\r
 243 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 244 </EM>\r
 245 </TD>\r
 246 </TR>\r
 247 \r
 248 <TR>\r
 249 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 250 &nbsp;<A HREF="../../compbio/engine/AsyncExecutor.html" title="interface in compbio.engine"><B>PREV CLASS</B></A>&nbsp;\r
 251 &nbsp;<A HREF="../../compbio/engine/ClusterJobId.html" title="class in compbio.engine"><B>NEXT CLASS</B></A></FONT></TD>\r
 252 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 253   <A HREF="../../index.html?compbio/engine/Cleaner.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 254 &nbsp;<A HREF="Cleaner.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 255 &nbsp;<SCRIPT type="text/javascript">\r
 256   <!--\r
 257   if(window==top) {\r
 258     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 259   }\r
 260   //-->\r
 261 </SCRIPT>\r
 262 <NOSCRIPT>\r
 263   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
 264 </NOSCRIPT>\r
 265 \r
 266 \r
 267 </FONT></TD>\r
 268 </TR>\r
 269 <TR>\r
 270 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 271   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
 272 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 273 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 274 </TR>\r
 275 </TABLE>\r
 276 <A NAME="skip-navbar_bottom"></A>\r
 277 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 278 \r
 279 <HR>\r
 280 \r
 281 </BODY>\r
 282 </HTML>\r