1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
5
<!-- Generated by javadoc (build 1.4.2_04) on Wed Apr 13 20:01:08 MEST 2005 -->
10
<META NAME="keywords" CONTENT="org.ggf.drmaa.FileTransferMode class">
12
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
14
<SCRIPT type="text/javascript">
15
function windowTitle()
17
parent.document.title="FileTransferMode";
23
<BODY BGCOLOR="white" onload="windowTitle();">
26
<!-- ========= START OF TOP NAVBAR ======= -->
27
<A NAME="navbar_top"><!-- --></A>
28
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
31
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32
<A NAME="navbar_top_firstrow"><!-- --></A>
33
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34
<TR ALIGN="center" VALIGN="top">
35
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
36
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
37
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
38
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
39
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
40
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
41
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
45
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
51
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52
<A HREF="../../../org/ggf/drmaa/ExitTimeoutException.html" title="class in org.ggf.drmaa"><B>PREV CLASS</B></A>
53
<A HREF="../../../org/ggf/drmaa/HoldInconsistentStateException.html" title="class in org.ggf.drmaa"><B>NEXT CLASS</B></A></FONT></TD>
54
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55
<A HREF="../../../index.html" target="_top"><B>FRAMES</B></A>
56
<A HREF="FileTransferMode.html" target="_top"><B>NO FRAMES</B></A>
57
<SCRIPT type="text/javascript">
60
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
65
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
71
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
72
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
73
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
77
<A NAME="skip-navbar_top"></A>
78
<!-- ========= END OF TOP NAVBAR ========= -->
81
<!-- ======== START OF CLASS DATA ======== -->
86
Class FileTransferMode</H2>
89
<IMG SRC="../../../resources/inherit.gif" ALT="extended by"><B>org.ggf.drmaa.FileTransferMode</B>
92
<DT><B>All Implemented Interfaces:</B> <DD>java.lang.Cloneable, java.io.Serializable</DD>
96
<DT>public class <B>FileTransferMode</B><DT>extends java.lang.Object<DT>implements java.io.Serializable, java.lang.Cloneable</DL>
99
This class represents the streams which should be used for file transfers. For
100
each of the three properties which is set to true, the corresponding stream's
101
path attribute in the job template will be treated as a source or destination
102
(depending on the stream) for file tranfers. For example, if the inputStream
103
property is set to true, the inputPath property of the JobTemplate will be
104
interpreted as a source from which to transfer files.
109
<DT><B>Since:</B></DT>
111
<DT><B>Author:</B></DT>
112
<DD>dan.templeton@sun.com</DD>
113
<DT><B>See Also:</B><DD><A HREF="../../../serialized-form.html#org.ggf.drmaa.FileTransferMode">Serialized Form</A></DL>
117
<!-- ======== NESTED CLASS SUMMARY ======== -->
120
<!-- =========== FIELD SUMMARY =========== -->
123
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
125
<A NAME="constructor_summary"><!-- --></A>
126
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
127
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
128
<TD COLSPAN=2><FONT SIZE="+2">
129
<B>Constructor Summary</B></FONT></TD>
131
<TR BGCOLOR="white" CLASS="TableRowColor">
132
<TD><CODE><B><A HREF="../../../org/ggf/drmaa/FileTransferMode.html#FileTransferMode()">FileTransferMode</A></B>()</CODE>
135
Creates a new instance of FileTransferMode</TD>
137
<TR BGCOLOR="white" CLASS="TableRowColor">
138
<TD><CODE><B><A HREF="../../../org/ggf/drmaa/FileTransferMode.html#FileTransferMode(boolean, boolean, boolean)">FileTransferMode</A></B>(boolean inputStream,
139
boolean outputStream,
140
boolean errorStream)</CODE>
143
Create a new instance with the property values preset.</TD>
147
<!-- ========== METHOD SUMMARY =========== -->
149
<A NAME="method_summary"><!-- --></A>
150
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
151
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
152
<TD COLSPAN=2><FONT SIZE="+2">
153
<B>Method Summary</B></FONT></TD>
155
<TR BGCOLOR="white" CLASS="TableRowColor">
156
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
157
<CODE> java.lang.Object</CODE></FONT></TD>
158
<TD><CODE><B><A HREF="../../../org/ggf/drmaa/FileTransferMode.html#clone()">clone</A></B>()</CODE>
161
Creates a copy of this FileTransferMode object.</TD>
163
<TR BGCOLOR="white" CLASS="TableRowColor">
164
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
165
<CODE> boolean</CODE></FONT></TD>
166
<TD><CODE><B><A HREF="../../../org/ggf/drmaa/FileTransferMode.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object obj)</CODE>
169
Test whether two FileTransferMode objects have the same property settings.</TD>
171
<TR BGCOLOR="white" CLASS="TableRowColor">
172
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
173
<CODE> boolean</CODE></FONT></TD>
174
<TD><CODE><B><A HREF="../../../org/ggf/drmaa/FileTransferMode.html#getErrorStream()">getErrorStream</A></B>()</CODE>
177
Whether to transfer error stream files.</TD>
179
<TR BGCOLOR="white" CLASS="TableRowColor">
180
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
181
<CODE> boolean</CODE></FONT></TD>
182
<TD><CODE><B><A HREF="../../../org/ggf/drmaa/FileTransferMode.html#getInputStream()">getInputStream</A></B>()</CODE>
185
Whether to transfer error stream files.</TD>
187
<TR BGCOLOR="white" CLASS="TableRowColor">
188
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
189
<CODE> boolean</CODE></FONT></TD>
190
<TD><CODE><B><A HREF="../../../org/ggf/drmaa/FileTransferMode.html#getOutputStream()">getOutputStream</A></B>()</CODE>
193
Whether to transfer error stream files.</TD>
195
<TR BGCOLOR="white" CLASS="TableRowColor">
196
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
197
<CODE> int</CODE></FONT></TD>
198
<TD><CODE><B><A HREF="../../../org/ggf/drmaa/FileTransferMode.html#hashCode()">hashCode</A></B>()</CODE>
201
Returns a hash code based on the file transfer properties.</TD>
203
<TR BGCOLOR="white" CLASS="TableRowColor">
204
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
205
<CODE> void</CODE></FONT></TD>
206
<TD><CODE><B><A HREF="../../../org/ggf/drmaa/FileTransferMode.html#setErrorStream(boolean)">setErrorStream</A></B>(boolean errorStream)</CODE>
209
Set whether to transfer error stream files.</TD>
211
<TR BGCOLOR="white" CLASS="TableRowColor">
212
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
213
<CODE> void</CODE></FONT></TD>
214
<TD><CODE><B><A HREF="../../../org/ggf/drmaa/FileTransferMode.html#setInputStream(boolean)">setInputStream</A></B>(boolean inputStream)</CODE>
217
Set whether to transfer error stream files.</TD>
219
<TR BGCOLOR="white" CLASS="TableRowColor">
220
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
221
<CODE> void</CODE></FONT></TD>
222
<TD><CODE><B><A HREF="../../../org/ggf/drmaa/FileTransferMode.html#setOutputStream(boolean)">setOutputStream</A></B>(boolean outputStream)</CODE>
225
Set whether to transfer error stream files.</TD>
227
<TR BGCOLOR="white" CLASS="TableRowColor">
228
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
229
<CODE> java.lang.String</CODE></FONT></TD>
230
<TD><CODE><B><A HREF="../../../org/ggf/drmaa/FileTransferMode.html#toString()">toString</A></B>()</CODE>
233
Returns a string containing the stream settings.</TD>
236
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
237
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
238
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
239
<TD><B>Methods inherited from class java.lang.Object</B></TD>
241
<TR BGCOLOR="white" CLASS="TableRowColor">
242
<TD><CODE>finalize, getClass, notify, notifyAll, wait, wait, wait</CODE></TD>
248
<!-- ============ FIELD DETAIL =========== -->
251
<!-- ========= CONSTRUCTOR DETAIL ======== -->
253
<A NAME="constructor_detail"><!-- --></A>
254
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
255
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
256
<TD COLSPAN=1><FONT SIZE="+2">
257
<B>Constructor Detail</B></FONT></TD>
261
<A NAME="FileTransferMode()"><!-- --></A><H3>
262
FileTransferMode</H3>
264
public <B>FileTransferMode</B>()</PRE>
266
<DD>Creates a new instance of FileTransferMode
271
<A NAME="FileTransferMode(boolean, boolean, boolean)"><!-- --></A><H3>
272
FileTransferMode</H3>
274
public <B>FileTransferMode</B>(boolean inputStream,
275
boolean outputStream,
276
boolean errorStream)</PRE>
278
<DD>Create a new instance with the property values preset.
280
<DT><B>Parameters:</B><DD><CODE>inputStream</CODE> - whether to transfer input stream files<DD><CODE>outputStream</CODE> - whether to transfer output stream files<DD><CODE>errorStream</CODE> - whether to transfer error stream files</DL>
282
<!-- ============ METHOD DETAIL ========== -->
284
<A NAME="method_detail"><!-- --></A>
285
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
286
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
287
<TD COLSPAN=1><FONT SIZE="+2">
288
<B>Method Detail</B></FONT></TD>
292
<A NAME="setErrorStream(boolean)"><!-- --></A><H3>
295
public void <B>setErrorStream</B>(boolean errorStream)</PRE>
297
<DD>Set whether to transfer error stream files.
303
<DT><B>Parameters:</B><DD><CODE>errorStream</CODE> - whether to transfer error stream files</DL>
308
<A NAME="getErrorStream()"><!-- --></A><H3>
311
public boolean <B>getErrorStream</B>()</PRE>
313
<DD>Whether to transfer error stream files.
320
<DT><B>Returns:</B><DD>whether to transfer error stream files</DL>
325
<A NAME="setInputStream(boolean)"><!-- --></A><H3>
328
public void <B>setInputStream</B>(boolean inputStream)</PRE>
330
<DD>Set whether to transfer error stream files.
336
<DT><B>Parameters:</B><DD><CODE>inputStream</CODE> - whether to transfer error stream files</DL>
341
<A NAME="getInputStream()"><!-- --></A><H3>
344
public boolean <B>getInputStream</B>()</PRE>
346
<DD>Whether to transfer error stream files.
353
<DT><B>Returns:</B><DD>whether to transfer error stream files</DL>
358
<A NAME="setOutputStream(boolean)"><!-- --></A><H3>
361
public void <B>setOutputStream</B>(boolean outputStream)</PRE>
363
<DD>Set whether to transfer error stream files.
369
<DT><B>Parameters:</B><DD><CODE>outputStream</CODE> - whether to transfer error stream files</DL>
374
<A NAME="getOutputStream()"><!-- --></A><H3>
377
public boolean <B>getOutputStream</B>()</PRE>
379
<DD>Whether to transfer error stream files.
386
<DT><B>Returns:</B><DD>whether to transfer error stream files</DL>
391
<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
394
public boolean <B>equals</B>(java.lang.Object obj)</PRE>
396
<DD>Test whether two FileTransferMode objects have the same property settings.
402
<DT><B>Parameters:</B><DD><CODE>obj</CODE> - the Object to test for equality
403
<DT><B>Returns:</B><DD>whether the FileTransferMode object has the same property settings as this one</DL>
408
<A NAME="hashCode()"><!-- --></A><H3>
411
public int <B>hashCode</B>()</PRE>
413
<DD>Returns a hash code based on the file transfer properties.
420
<DT><B>Returns:</B><DD>a hash code based on the file transfer properties</DL>
425
<A NAME="clone()"><!-- --></A><H3>
428
public java.lang.Object <B>clone</B>()</PRE>
430
<DD>Creates a copy of this FileTransferMode object.
437
<DT><B>Returns:</B><DD>a copy of this FileTransferMode object</DL>
442
<A NAME="toString()"><!-- --></A><H3>
445
public java.lang.String <B>toString</B>()</PRE>
447
<DD>Returns a string containing the stream settings.
454
<DT><B>Returns:</B><DD>a string containing the stream settings</DL>
457
<!-- ========= END OF CLASS DATA ========= -->
461
<!-- ======= START OF BOTTOM NAVBAR ====== -->
462
<A NAME="navbar_bottom"><!-- --></A>
463
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
464
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
466
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
467
<A NAME="navbar_bottom_firstrow"><!-- --></A>
468
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
469
<TR ALIGN="center" VALIGN="top">
470
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
471
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
472
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
473
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
474
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
475
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
476
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
480
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
486
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
487
<A HREF="../../../org/ggf/drmaa/ExitTimeoutException.html" title="class in org.ggf.drmaa"><B>PREV CLASS</B></A>
488
<A HREF="../../../org/ggf/drmaa/HoldInconsistentStateException.html" title="class in org.ggf.drmaa"><B>NEXT CLASS</B></A></FONT></TD>
489
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
490
<A HREF="../../../index.html" target="_top"><B>FRAMES</B></A>
491
<A HREF="FileTransferMode.html" target="_top"><B>NO FRAMES</B></A>
492
<SCRIPT type="text/javascript">
495
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
500
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
506
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
507
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
508
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
509
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
512
<A NAME="skip-navbar_bottom"></A>
513
<!-- ======== END OF BOTTOM NAVBAR ======= -->