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_14) on Wed Feb 17 16:46:49 GMT 2010 -->\r
   6 <TITLE>\r
   7 Cleaner\r
   8 </TITLE>\r
   9 \r
  10 <META NAME="date" CONTENT="2010-02-17">\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 java.lang.Object\r
  96   <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>compbio.engine.Cleaner</B>\r
  97 </PRE>\r
  98 <HR>\r
  99 <DL>\r
 100 <DT><PRE>public class <B>Cleaner</B><DT>extends java.lang.Object</DL>\r
 101 </PRE>\r
 102 \r
 103 <P>\r
 104 <HR>\r
 105 \r
 106 <P>\r
 107 \r
 108 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
 109 \r
 110 <A NAME="constructor_summary"><!-- --></A>\r
 111 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 112 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 113 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 114 <B>Constructor Summary</B></FONT></TH>\r
 115 </TR>\r
 116 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 117 <TD><CODE><B><A HREF="../../compbio/engine/Cleaner.html#Cleaner()">Cleaner</A></B>()</CODE>\r
 118 \r
 119 <BR>\r
 120 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 121 </TR>\r
 122 </TABLE>\r
 123 &nbsp;\r
 124 <!-- ========== METHOD SUMMARY =========== -->\r
 125 \r
 126 <A NAME="method_summary"><!-- --></A>\r
 127 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 128 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 129 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 130 <B>Method Summary</B></FONT></TH>\r
 131 </TR>\r
 132 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 133 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 134 <CODE>static&nbsp;boolean</CODE></FONT></TD>\r
 135 <TD><CODE><B><A HREF="../../compbio/engine/Cleaner.html#deleteAllFiles(java.lang.String)">deleteAllFiles</A></B>(java.lang.String&nbsp;directory)</CODE>\r
 136 \r
 137 <BR>\r
 138 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 139 </TR>\r
 140 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 141 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 142 <CODE>static&nbsp;boolean</CODE></FONT></TD>\r
 143 <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
 144 \r
 145 <BR>\r
 146 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method returns true if all files specified by List files were
 147  successfully removed or there was no files to remove (files list was
 148  empty)</TD>\r
 149 </TR>\r
 150 </TABLE>\r
 151 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
 152 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 153 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 154 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>\r
 155 </TR>\r
 156 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 157 <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
 158 </TR>\r
 159 </TABLE>\r
 160 &nbsp;\r
 161 <P>\r
 162 \r
 163 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
 164 \r
 165 <A NAME="constructor_detail"><!-- --></A>\r
 166 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 167 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 168 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 169 <B>Constructor Detail</B></FONT></TH>\r
 170 </TR>\r
 171 </TABLE>\r
 172 \r
 173 <A NAME="Cleaner()"><!-- --></A><H3>\r
 174 Cleaner</H3>\r
 175 <PRE>\r
 176 public <B>Cleaner</B>()</PRE>\r
 177 <DL>\r
 178 </DL>\r
 179 \r
 180 <!-- ============ METHOD DETAIL ========== -->\r
 181 \r
 182 <A NAME="method_detail"><!-- --></A>\r
 183 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 184 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 185 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 186 <B>Method Detail</B></FONT></TH>\r
 187 </TR>\r
 188 </TABLE>\r
 189 \r
 190 <A NAME="deleteFiles(compbio.engine.client.ConfiguredExecutable)"><!-- --></A><H3>\r
 191 deleteFiles</H3>\r
 192 <PRE>\r
 193 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
 194 <DL>\r
 195 <DD>This method returns true if all files specified by List files were
 196  successfully removed or there was no files to remove (files list was
 197  empty)\r
 198 <P>\r
 199 <DD><DL>\r
 200 <DT><B>Parameters:</B><DD><CODE>workDirectory</CODE> - <DD><CODE>files</CODE> - \r
 201 <DT><B>Returns:</B><DD></DL>\r
 202 </DD>\r
 203 </DL>\r
 204 <HR>\r
 205 \r
 206 <A NAME="deleteAllFiles(java.lang.String)"><!-- --></A><H3>\r
 207 deleteAllFiles</H3>\r
 208 <PRE>\r
 209 public static boolean <B>deleteAllFiles</B>(java.lang.String&nbsp;directory)</PRE>\r
 210 <DL>\r
 211 <DD><DL>\r
 212 </DL>\r
 213 </DD>\r
 214 </DL>\r
 215 <!-- ========= END OF CLASS DATA ========= -->\r
 216 <HR>\r
 217 \r
 218 \r
 219 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 220 <A NAME="navbar_bottom"><!-- --></A>\r
 221 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
 222 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 223 <TR>\r
 224 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 225 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
 226 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 227   <TR ALIGN="center" VALIGN="top">\r
 228   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 229   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 230   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 231   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Cleaner.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
 232   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 233   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 234   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 235   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 236   </TR>\r
 237 </TABLE>\r
 238 </TD>\r
 239 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 240 </EM>\r
 241 </TD>\r
 242 </TR>\r
 243 \r
 244 <TR>\r
 245 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 246 &nbsp;<A HREF="../../compbio/engine/AsyncExecutor.html" title="interface in compbio.engine"><B>PREV CLASS</B></A>&nbsp;\r
 247 &nbsp;<A HREF="../../compbio/engine/ClusterJobId.html" title="class in compbio.engine"><B>NEXT CLASS</B></A></FONT></TD>\r
 248 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 249   <A HREF="../../index.html?compbio/engine/Cleaner.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 250 &nbsp;<A HREF="Cleaner.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 251 &nbsp;<SCRIPT type="text/javascript">\r
 252   <!--\r
 253   if(window==top) {\r
 254     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 255   }\r
 256   //-->\r
 257 </SCRIPT>\r
 258 <NOSCRIPT>\r
 259   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
 260 </NOSCRIPT>\r
 261 \r
 262 \r
 263 </FONT></TD>\r
 264 </TR>\r
 265 <TR>\r
 266 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 267   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
 268 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 269 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 270 </TR>\r
 271 </TABLE>\r
 272 <A NAME="skip-navbar_bottom"></A>\r
 273 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 274 \r
 275 <HR>\r
 276 \r
 277 </BODY>\r
 278 </HTML>\r