website/full_javadoc/compbio/engine/client/EnvVariableProcessor.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 EnvVariableProcessor\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="EnvVariableProcessor";\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/EnvVariableProcessor.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/client/ConfiguredExecutable.html" title="interface in compbio.engine.client"><B>PREV CLASS</B></A>&nbsp;\r
  59 &nbsp;<A HREF="../../../compbio/engine/client/Executable.html" title="interface in compbio.engine.client"><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/client/EnvVariableProcessor.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
  62 &nbsp;<A HREF="EnvVariableProcessor.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;<A HREF="#field_summary">FIELD</A>&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;<A HREF="#field_detail">FIELD</A>&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.client</FONT>\r
  92 <BR>\r
  93 Class EnvVariableProcessor</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.client.EnvVariableProcessor</B>\r
  97 </PRE>\r
  98 <HR>\r
  99 <DL>\r
 100 <DT><PRE>public class <B>EnvVariableProcessor</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
 101 </PRE>\r
 102 \r
 103 <P>\r
 104 <HR>\r
 105 \r
 106 <P>\r
 107 <!-- =========== FIELD SUMMARY =========== -->\r
 108 \r
 109 <A NAME="field_summary"><!-- --></A>\r
 110 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 111 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 112 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 113 <B>Field Summary</B></FONT></TH>\r
 114 </TR>\r
 115 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 116 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 117 <CODE>static&nbsp;<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></CODE></FONT></TD>\r
 118 <TD><CODE><B><A HREF="../../../compbio/engine/client/EnvVariableProcessor.html#PATH">PATH</A></B></CODE>\r
 119 \r
 120 <BR>\r
 121 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Special variable keys Absolute path(s) will be merged with the content of
 122  the system PATH variable</TD>\r
 123 </TR>\r
 124 </TABLE>\r
 125 &nbsp;\r
 126 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
 127 \r
 128 <A NAME="constructor_summary"><!-- --></A>\r
 129 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 130 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 131 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 132 <B>Constructor Summary</B></FONT></TH>\r
 133 </TR>\r
 134 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 135 <TD><CODE><B><A HREF="../../../compbio/engine/client/EnvVariableProcessor.html#EnvVariableProcessor()">EnvVariableProcessor</A></B>()</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 </TABLE>\r
 141 &nbsp;\r
 142 <!-- ========== METHOD SUMMARY =========== -->\r
 143 \r
 144 <A NAME="method_summary"><!-- --></A>\r
 145 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 146 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 147 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 148 <B>Method Summary</B></FONT></TH>\r
 149 </TR>\r
 150 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 151 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 152 <CODE>static&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&lt;<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>,<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>&gt;</CODE></FONT></TD>\r
 153 <TD><CODE><B><A HREF="../../../compbio/engine/client/EnvVariableProcessor.html#getEnvVariables(java.lang.String, java.lang.Class)">getEnvVariables</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;property,\r
 154                 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A>&lt;?&gt;&nbsp;clazz)</CODE>\r
 155 \r
 156 <BR>\r
 157 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 158 </TR>\r
 159 </TABLE>\r
 160 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
 161 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 162 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 163 <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
 164 </TR>\r
 165 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 166 <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
 167 </TR>\r
 168 </TABLE>\r
 169 &nbsp;\r
 170 <P>\r
 171 \r
 172 <!-- ============ FIELD DETAIL =========== -->\r
 173 \r
 174 <A NAME="field_detail"><!-- --></A>\r
 175 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 176 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 177 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 178 <B>Field Detail</B></FONT></TH>\r
 179 </TR>\r
 180 </TABLE>\r
 181 \r
 182 <A NAME="PATH"><!-- --></A><H3>\r
 183 PATH</H3>\r
 184 <PRE>\r
 185 public static final <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> <B>PATH</B></PRE>\r
 186 <DL>\r
 187 <DD>Special variable keys Absolute path(s) will be merged with the content of
 188  the system PATH variable\r
 189 <P>\r
 190 <DL>\r
 191 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#compbio.engine.client.EnvVariableProcessor.PATH">Constant Field Values</A></DL>\r
 192 </DL>\r
 193 \r
 194 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
 195 \r
 196 <A NAME="constructor_detail"><!-- --></A>\r
 197 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 198 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 199 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 200 <B>Constructor Detail</B></FONT></TH>\r
 201 </TR>\r
 202 </TABLE>\r
 203 \r
 204 <A NAME="EnvVariableProcessor()"><!-- --></A><H3>\r
 205 EnvVariableProcessor</H3>\r
 206 <PRE>\r
 207 public <B>EnvVariableProcessor</B>()</PRE>\r
 208 <DL>\r
 209 </DL>\r
 210 \r
 211 <!-- ============ METHOD DETAIL ========== -->\r
 212 \r
 213 <A NAME="method_detail"><!-- --></A>\r
 214 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 215 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 216 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 217 <B>Method Detail</B></FONT></TH>\r
 218 </TR>\r
 219 </TABLE>\r
 220 \r
 221 <A NAME="getEnvVariables(java.lang.String, java.lang.Class)"><!-- --></A><H3>\r
 222 getEnvVariables</H3>\r
 223 <PRE>\r
 224 public static <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&lt;<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>,<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>&gt; <B>getEnvVariables</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;property,\r
 225                                                  <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A>&lt;?&gt;&nbsp;clazz)</PRE>\r
 226 <DL>\r
 227 <DD><DL>\r
 228 </DL>\r
 229 </DD>\r
 230 </DL>\r
 231 <!-- ========= END OF CLASS DATA ========= -->\r
 232 <HR>\r
 233 \r
 234 \r
 235 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 236 <A NAME="navbar_bottom"><!-- --></A>\r
 237 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
 238 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 239 <TR>\r
 240 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 241 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
 242 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 243   <TR ALIGN="center" VALIGN="top">\r
 244   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 245   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 246   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 247   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/EnvVariableProcessor.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
 248   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 249   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 250   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 251   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 252   </TR>\r
 253 </TABLE>\r
 254 </TD>\r
 255 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 256 </EM>\r
 257 </TD>\r
 258 </TR>\r
 259 \r
 260 <TR>\r
 261 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 262 &nbsp;<A HREF="../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client"><B>PREV CLASS</B></A>&nbsp;\r
 263 &nbsp;<A HREF="../../../compbio/engine/client/Executable.html" title="interface in compbio.engine.client"><B>NEXT CLASS</B></A></FONT></TD>\r
 264 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 265   <A HREF="../../../index.html?compbio/engine/client/EnvVariableProcessor.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 266 &nbsp;<A HREF="EnvVariableProcessor.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 267 &nbsp;<SCRIPT type="text/javascript">\r
 268   <!--\r
 269   if(window==top) {\r
 270     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 271   }\r
 272   //-->\r
 273 </SCRIPT>\r
 274 <NOSCRIPT>\r
 275   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
 276 </NOSCRIPT>\r
 277 \r
 278 \r
 279 </FONT></TD>\r
 280 </TR>\r
 281 <TR>\r
 282 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 283   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
 284 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 285 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 286 </TR>\r
 287 </TABLE>\r
 288 <A NAME="skip-navbar_bottom"></A>\r
 289 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 290 \r
 291 <HR>\r
 292 \r
 293 </BODY>\r
 294 </HTML>\r