← Back to branch summary

~ubuntu-branches/ubuntu/utopic/gridengine/utopic

« back to all changes in this revision

Viewing changes to doc/javadocs/org/ggf/drmaa/PartialTimestampFormat.html

  • Committer: Bazaar Package Importer
  • Author(s): Mark Hymers
  • Date: 2008-06-25 22:36:13 UTC
  • Revision ID: james.westby@ubuntu.com-20080625223613-tvd9xlhuoct9kyhm
Tags: upstream-6.2~beta2
Import upstream version 6.2~beta2

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/javadocs/org/ggf/drmaa/PartialTimestampFormat.html
 
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.4.2_04) on Wed Apr 13 20:01:10 MEST 2005 -->
 
6
<TITLE>
 
7
PartialTimestampFormat
 
8
</TITLE>
 
9
 
 
10
<META NAME="keywords" CONTENT="org.ggf.drmaa.PartialTimestampFormat class">
 
11
 
 
12
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
 
13
 
 
14
<SCRIPT type="text/javascript">
 
15
function windowTitle()
 
16
{
 
17
    parent.document.title="PartialTimestampFormat";
 
18
}
 
19
</SCRIPT>
 
20
 
 
21
</HEAD>
 
22
 
 
23
<BODY BGCOLOR="white" onload="windowTitle();">
 
24
 
 
25
 
 
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="">
 
30
<TR>
 
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>&nbsp;</TD>
 
36
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 
37
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 
38
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 
39
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 
40
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 
41
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 
42
  </TR>
 
43
</TABLE>
 
44
</TD>
 
45
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 
46
</EM>
 
47
</TD>
 
48
</TR>
 
49
 
 
50
<TR>
 
51
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
52
&nbsp;<A HREF="../../../org/ggf/drmaa/PartialTimestamp.html" title="class in org.ggf.drmaa"><B>PREV CLASS</B></A>&nbsp;
 
53
&nbsp;<A HREF="../../../org/ggf/drmaa/ReleaseInconsistentStateException.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>  &nbsp;
 
56
&nbsp;<A HREF="PartialTimestampFormat.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 
57
&nbsp;<SCRIPT type="text/javascript">
 
58
  <!--
 
59
  if(window==top) {
 
60
    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
 
61
  }
 
62
  //-->
 
63
</SCRIPT>
 
64
<NOSCRIPT>
 
65
  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
 
66
</NOSCRIPT>
 
67
 
 
68
</FONT></TD>
 
69
</TR>
 
70
<TR>
 
71
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
72
  SUMMARY:&nbsp;<A HREF="#nested_classes_inherited_from_class_java.text.Format">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 
73
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
74
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 
75
</TR>
 
76
</TABLE>
 
77
<A NAME="skip-navbar_top"></A>
 
78
<!-- ========= END OF TOP NAVBAR ========= -->
 
79
 
 
80
<HR>
 
81
<!-- ======== START OF CLASS DATA ======== -->
 
82
<H2>
 
83
<FONT SIZE="-1">
 
84
org.ggf.drmaa</FONT>
 
85
<BR>
 
86
Class PartialTimestampFormat</H2>
 
87
<PRE>
 
88
java.lang.Object
 
89
  <IMG SRC="../../../resources/inherit.gif" ALT="extended by">java.text.Format
 
90
      <IMG SRC="../../../resources/inherit.gif" ALT="extended by"><B>org.ggf.drmaa.PartialTimestampFormat</B>
 
91
</PRE>
 
92
<DL>
 
93
<DT><B>All Implemented Interfaces:</B> <DD>java.lang.Cloneable, java.io.Serializable</DD>
 
94
</DL>
 
95
<HR>
 
96
<DL>
 
97
<DT>public class <B>PartialTimestampFormat</B><DT>extends java.text.Format</DL>
 
98
 
 
99
<P>
 
100
<p>This class coverts a PartialTimestamp to and from the DRMAA specified time
 
101
 string.  In order to represent a PartialTimestamp object as a string, the
 
102
 PartialTimestamp object cannot have an unset field that is less significant than
 
103
 the most significant set field.  That is to say that if <code>CENTURY</code> is set, <code>YEAR</code>,
 
104
 <code>MONTH</code>, and <code>DAY_OF_MONTH</code> must also be set.  <code>SECONDS</code> and <code>ZONE_OFFSET</code> are always
 
105
 optional.</p>
 
106
 <p>Example:</p>
 
107
 <pre>   PartialTimestamp date = new PartialTimestamp ();
 
108
   PartialTimestampFormat ptf = new PartialTimestampFormat ();
 
109
 
 
110
   date.set (PartialTimestamp.HOUR_OF_DAY, 11);
 
111
   date.set (PartialTimestamp.MINUTE, 30);
 
112
 
 
113
   String timeString = ptf.format (date);
 
114
 
 
115
   PartialTimestamp date2 = ptf.parse (timeString);
 
116
 
 
117
   assert (date.equals (date2));
 
118
 </pre>
 
119
<P>
 
120
 
 
121
<P>
 
122
<DL>
 
123
<DT><B>Since:</B></DT>
 
124
  <DD>0.5</DD>
 
125
<DT><B>Author:</B></DT>
 
126
  <DD>dan.templeton@sun.com</DD>
 
127
<DT><B>See Also:</B><DD><A HREF="../../../org/ggf/drmaa/PartialTimestamp.html" title="class in org.ggf.drmaa"><CODE>PartialTimestamp</CODE></A>, 
 
128
<A HREF="../../../serialized-form.html#org.ggf.drmaa.PartialTimestampFormat">Serialized Form</A></DL>
 
129
<HR>
 
130
 
 
131
<P>
 
132
<!-- ======== NESTED CLASS SUMMARY ======== -->
 
133
 
 
134
<A NAME="nested_class_summary"><!-- --></A>
 
135
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 
136
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
137
<TD COLSPAN=2><FONT SIZE="+2">
 
138
<B>Nested Class Summary</B></FONT></TD>
 
139
</TR>
 
140
</TABLE>
 
141
&nbsp;<A NAME="nested_classes_inherited_from_class_java.text.Format"><!-- --></A>
 
142
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 
143
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 
144
<TD><B>Nested classes inherited from class java.text.Format</B></TD>
 
145
</TR>
 
146
<TR BGCOLOR="white" CLASS="TableRowColor">
 
147
<TD><CODE>java.text.Format.Field</CODE></TD>
 
148
</TR>
 
149
</TABLE>
 
150
&nbsp;
 
151
<!-- =========== FIELD SUMMARY =========== -->
 
152
 
 
153
 
 
154
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
 
155
 
 
156
<A NAME="constructor_summary"><!-- --></A>
 
157
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 
158
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
159
<TD COLSPAN=2><FONT SIZE="+2">
 
160
<B>Constructor Summary</B></FONT></TD>
 
161
</TR>
 
162
<TR BGCOLOR="white" CLASS="TableRowColor">
 
163
<TD><CODE><B><A HREF="../../../org/ggf/drmaa/PartialTimestampFormat.html#PartialTimestampFormat()">PartialTimestampFormat</A></B>()</CODE>
 
164
 
 
165
<BR>
 
166
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new instance of PartialTimestampFormat</TD>
 
167
</TR>
 
168
</TABLE>
 
169
&nbsp;
 
170
<!-- ========== METHOD SUMMARY =========== -->
 
171
 
 
172
<A NAME="method_summary"><!-- --></A>
 
173
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 
174
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
175
<TD COLSPAN=2><FONT SIZE="+2">
 
176
<B>Method Summary</B></FONT></TD>
 
177
</TR>
 
178
<TR BGCOLOR="white" CLASS="TableRowColor">
 
179
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
180
<CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
 
181
<TD><CODE><B><A HREF="../../../org/ggf/drmaa/PartialTimestampFormat.html#clone()">clone</A></B>()</CODE>
 
182
 
 
183
<BR>
 
184
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a copy of this object.</TD>
 
185
</TR>
 
186
<TR BGCOLOR="white" CLASS="TableRowColor">
 
187
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
188
<CODE>&nbsp;java.lang.StringBuffer</CODE></FONT></TD>
 
189
<TD><CODE><B><A HREF="../../../org/ggf/drmaa/PartialTimestampFormat.html#format(java.lang.Object, java.lang.StringBuffer, java.text.FieldPosition)">format</A></B>(java.lang.Object&nbsp;obj,
 
190
       java.lang.StringBuffer&nbsp;stringBuffer,
 
191
       java.text.FieldPosition&nbsp;fieldPosition)</CODE>
 
192
 
 
193
<BR>
 
194
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Translates the PartialTimestamp into a DRMAA specified time string and appends
 
195
 the string to the given StringBuffer.</TD>
 
196
</TR>
 
197
<TR BGCOLOR="white" CLASS="TableRowColor">
 
198
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
199
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
 
200
<TD><CODE><B><A HREF="../../../org/ggf/drmaa/PartialTimestampFormat.html#format(org.ggf.drmaa.PartialTimestamp)">format</A></B>(<A HREF="../../../org/ggf/drmaa/PartialTimestamp.html" title="class in org.ggf.drmaa">PartialTimestamp</A>&nbsp;obj)</CODE>
 
201
 
 
202
<BR>
 
203
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Translates the PartialTimestamp into a DRMAA specified time string.</TD>
 
204
</TR>
 
205
<TR BGCOLOR="white" CLASS="TableRowColor">
 
206
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
207
<CODE>&nbsp;java.lang.StringBuffer</CODE></FONT></TD>
 
208
<TD><CODE><B><A HREF="../../../org/ggf/drmaa/PartialTimestampFormat.html#format(org.ggf.drmaa.PartialTimestamp, java.lang.StringBuffer, java.text.FieldPosition)">format</A></B>(<A HREF="../../../org/ggf/drmaa/PartialTimestamp.html" title="class in org.ggf.drmaa">PartialTimestamp</A>&nbsp;obj,
 
209
       java.lang.StringBuffer&nbsp;stringBuffer,
 
210
       java.text.FieldPosition&nbsp;fieldPosition)</CODE>
 
211
 
 
212
<BR>
 
213
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Translates the PartialTimestamp into a DRMAA specified time string and appends
 
214
 the string to the given StringBuffer.</TD>
 
215
</TR>
 
216
<TR BGCOLOR="white" CLASS="TableRowColor">
 
217
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
218
<CODE>&nbsp;<A HREF="../../../org/ggf/drmaa/PartialTimestamp.html" title="class in org.ggf.drmaa">PartialTimestamp</A></CODE></FONT></TD>
 
219
<TD><CODE><B><A HREF="../../../org/ggf/drmaa/PartialTimestampFormat.html#parse(java.lang.String)">parse</A></B>(java.lang.String&nbsp;str)</CODE>
 
220
 
 
221
<BR>
 
222
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Translates a DRMAA specified time string into a PartialTimestamp object.</TD>
 
223
</TR>
 
224
<TR BGCOLOR="white" CLASS="TableRowColor">
 
225
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
226
<CODE>&nbsp;<A HREF="../../../org/ggf/drmaa/PartialTimestamp.html" title="class in org.ggf.drmaa">PartialTimestamp</A></CODE></FONT></TD>
 
227
<TD><CODE><B><A HREF="../../../org/ggf/drmaa/PartialTimestampFormat.html#parse(java.lang.String, java.text.ParsePosition)">parse</A></B>(java.lang.String&nbsp;str,
 
228
      java.text.ParsePosition&nbsp;parsePosition)</CODE>
 
229
 
 
230
<BR>
 
231
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Translates a DRMAA specified time string into a PartialTimestamp object.</TD>
 
232
</TR>
 
233
<TR BGCOLOR="white" CLASS="TableRowColor">
 
234
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
235
<CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
 
236
<TD><CODE><B><A HREF="../../../org/ggf/drmaa/PartialTimestampFormat.html#parseObject(java.lang.String, java.text.ParsePosition)">parseObject</A></B>(java.lang.String&nbsp;str,
 
237
            java.text.ParsePosition&nbsp;parsePosition)</CODE>
 
238
 
 
239
<BR>
 
240
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Translates a DRMAA specified time string into a PartialTimestamp object.</TD>
 
241
</TR>
 
242
</TABLE>
 
243
&nbsp;<A NAME="methods_inherited_from_class_java.text.Format"><!-- --></A>
 
244
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 
245
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 
246
<TD><B>Methods inherited from class java.text.Format</B></TD>
 
247
</TR>
 
248
<TR BGCOLOR="white" CLASS="TableRowColor">
 
249
<TD><CODE>format, formatToCharacterIterator, parseObject</CODE></TD>
 
250
</TR>
 
251
</TABLE>
 
252
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 
253
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 
254
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 
255
<TD><B>Methods inherited from class java.lang.Object</B></TD>
 
256
</TR>
 
257
<TR BGCOLOR="white" CLASS="TableRowColor">
 
258
<TD><CODE>equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
 
259
</TR>
 
260
</TABLE>
 
261
&nbsp;
 
262
<P>
 
263
 
 
264
<!-- ============ FIELD DETAIL =========== -->
 
265
 
 
266
 
 
267
<!-- ========= CONSTRUCTOR DETAIL ======== -->
 
268
 
 
269
<A NAME="constructor_detail"><!-- --></A>
 
270
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 
271
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
272
<TD COLSPAN=1><FONT SIZE="+2">
 
273
<B>Constructor Detail</B></FONT></TD>
 
274
</TR>
 
275
</TABLE>
 
276
 
 
277
<A NAME="PartialTimestampFormat()"><!-- --></A><H3>
 
278
PartialTimestampFormat</H3>
 
279
<PRE>
 
280
public <B>PartialTimestampFormat</B>()</PRE>
 
281
<DL>
 
282
<DD>Creates a new instance of PartialTimestampFormat
 
283
<P>
 
284
</DL>
 
285
 
 
286
<!-- ============ METHOD DETAIL ========== -->
 
287
 
 
288
<A NAME="method_detail"><!-- --></A>
 
289
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 
290
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
291
<TD COLSPAN=1><FONT SIZE="+2">
 
292
<B>Method Detail</B></FONT></TD>
 
293
</TR>
 
294
</TABLE>
 
295
 
 
296
<A NAME="clone()"><!-- --></A><H3>
 
297
clone</H3>
 
298
<PRE>
 
299
public java.lang.Object <B>clone</B>()</PRE>
 
300
<DL>
 
301
<DD>Creates a copy of this object.  In reality, this method just creates a new
 
302
 PartialTimestampFormat object since PartialTimestampFormat contains no state.
 
303
<P>
 
304
<DD><DL>
 
305
 
 
306
<DT><B>Returns:</B><DD>a copy of this object</DL>
 
307
</DD>
 
308
</DL>
 
309
<HR>
 
310
 
 
311
<A NAME="format(java.lang.Object, java.lang.StringBuffer, java.text.FieldPosition)"><!-- --></A><H3>
 
312
format</H3>
 
313
<PRE>
 
314
public java.lang.StringBuffer <B>format</B>(java.lang.Object&nbsp;obj,
 
315
                                     java.lang.StringBuffer&nbsp;stringBuffer,
 
316
                                     java.text.FieldPosition&nbsp;fieldPosition)</PRE>
 
317
<DL>
 
318
<DD><p>Translates the PartialTimestamp into a DRMAA specified time string and appends
 
319
 the string to the given StringBuffer.  Since the PartialTimestampFormat class
 
320
 doesn't use fields, the fieldPosition parameter is ignored.  This method is
 
321
 equivalent to <code>stringBuffer.append (format (obj))</code>.</p>
 
322
 <p>In order to represent a PartialTimestamp object as a string, the
 
323
 PartialTimestamp object cannot have an unset field that is less significant than
 
324
 the most significant set field.  TThat is to say that if <code>CENTURY</code> is set, <code>YEAR</code>,
 
325
 <code>MONTH</code>, and <code>DAY_OF_MONTH</code> must also be set.  <code>SECONDS</code> and <code>ZONE_OFFSET</code> are always
 
326
 optional.</p>
 
327
<P>
 
328
<DD><DL>
 
329
<DT><B>Parameters:</B><DD><CODE>obj</CODE> - the object to format<DD><CODE>stringBuffer</CODE> - the StringBuffer to which to append the results<DD><CODE>fieldPosition</CODE> - ignored
 
330
<DT><B>Returns:</B><DD>the stringBuffer parameter</DL>
 
331
</DD>
 
332
</DL>
 
333
<HR>
 
334
 
 
335
<A NAME="format(org.ggf.drmaa.PartialTimestamp, java.lang.StringBuffer, java.text.FieldPosition)"><!-- --></A><H3>
 
336
format</H3>
 
337
<PRE>
 
338
public java.lang.StringBuffer <B>format</B>(<A HREF="../../../org/ggf/drmaa/PartialTimestamp.html" title="class in org.ggf.drmaa">PartialTimestamp</A>&nbsp;obj,
 
339
                                     java.lang.StringBuffer&nbsp;stringBuffer,
 
340
                                     java.text.FieldPosition&nbsp;fieldPosition)</PRE>
 
341
<DL>
 
342
<DD><p>Translates the PartialTimestamp into a DRMAA specified time string and appends
 
343
 the string to the given StringBuffer.  Since the PartialTimestampFormat class
 
344
 doesn't use fields, the fieldPosition parameter is ignored.  This method is
 
345
 equivalent to <code>stringBuffer.append (format (obj))</code>.</p>
 
346
 <p>In order to represent a PartialTimestamp object as a string, the
 
347
 PartialTimestamp object cannot have an unset field that is less significant than
 
348
 the most significant set field.  That is to say that if <code>CENTURY</code> is set, <code>YEAR</code>,
 
349
 <code>MONTH</code>, and <code>DAY_OF_MONTH</code> must also be set.  <code>SECONDS</code> and <code>ZONE_OFFSET</code> are always
 
350
 optional.</p>
 
351
<P>
 
352
<DD><DL>
 
353
<DT><B>Parameters:</B><DD><CODE>obj</CODE> - the object to format<DD><CODE>stringBuffer</CODE> - the StringBuffer to which to append the results<DD><CODE>fieldPosition</CODE> - ignored
 
354
<DT><B>Returns:</B><DD>the stringBuffer parameter</DL>
 
355
</DD>
 
356
</DL>
 
357
<HR>
 
358
 
 
359
<A NAME="format(org.ggf.drmaa.PartialTimestamp)"><!-- --></A><H3>
 
360
format</H3>
 
361
<PRE>
 
362
public java.lang.String <B>format</B>(<A HREF="../../../org/ggf/drmaa/PartialTimestamp.html" title="class in org.ggf.drmaa">PartialTimestamp</A>&nbsp;obj)</PRE>
 
363
<DL>
 
364
<DD><p>Translates the PartialTimestamp into a DRMAA specified time string.  This method
 
365
 is equivalent to <code>format (obj, new StringBuffer (), new FieldPosition (0)).toString
 
366
 ()</code>.</p>
 
367
 <p>In order to represent a PartialTimestamp object as a string, the
 
368
 PartialTimestamp object cannot have an unset field that is less significant than
 
369
 the most significant set field.  That is to say that if <code>CENTURY</code> is set, <code>YEAR</code>,
 
370
 <code>MONTH</code>, and <code>DAY_OF_MONTH</code> must also be set.  <code>SECONDS</code> and <code>ZONE_OFFSET</code> are always
 
371
 optional.</p>
 
372
<P>
 
373
<DD><DL>
 
374
<DT><B>Parameters:</B><DD><CODE>obj</CODE> - the object to format
 
375
<DT><B>Returns:</B><DD>the DRMAA specified time string</DL>
 
376
</DD>
 
377
</DL>
 
378
<HR>
 
379
 
 
380
<A NAME="parse(java.lang.String)"><!-- --></A><H3>
 
381
parse</H3>
 
382
<PRE>
 
383
public <A HREF="../../../org/ggf/drmaa/PartialTimestamp.html" title="class in org.ggf.drmaa">PartialTimestamp</A> <B>parse</B>(java.lang.String&nbsp;str)
 
384
                       throws java.text.ParseException</PRE>
 
385
<DL>
 
386
<DD>Translates a DRMAA specified time string into a PartialTimestamp object.  This
 
387
 method will parse as far as possible, but after successfully parsing the
 
388
 <code>HOUR_OF_DAY</code> and <code>MINUTE</code> fields, if it encounters unparsable text, it will stop
 
389
 and will <b>not</b> throw a java.text.ParseException.
 
390
<P>
 
391
<DD><DL>
 
392
<DT><B>Parameters:</B><DD><CODE>str</CODE> - a DRMAA specified time string
 
393
<DT><B>Returns:</B><DD>a PartialTimestamp object
 
394
<DT><B>Throws:</B>
 
395
<DD><CODE>java.text.ParseException</CODE> - thrown if the string is not parsable.</DL>
 
396
</DD>
 
397
</DL>
 
398
<HR>
 
399
 
 
400
<A NAME="parse(java.lang.String, java.text.ParsePosition)"><!-- --></A><H3>
 
401
parse</H3>
 
402
<PRE>
 
403
public <A HREF="../../../org/ggf/drmaa/PartialTimestamp.html" title="class in org.ggf.drmaa">PartialTimestamp</A> <B>parse</B>(java.lang.String&nbsp;str,
 
404
                              java.text.ParsePosition&nbsp;parsePosition)</PRE>
 
405
<DL>
 
406
<DD>Translates a DRMAA specified time string into a PartialTimestamp object.  This
 
407
 method will parse as far as possible.  Upon completion, the parse position
 
408
 object will contain the index of the last character parsed.
 
409
<P>
 
410
<DD><DL>
 
411
<DT><B>Parameters:</B><DD><CODE>str</CODE> - a DRMAA specified time string<DD><CODE>parsePosition</CODE> - the parse position object
 
412
<DT><B>Returns:</B><DD>a PartialTimestamp object</DL>
 
413
</DD>
 
414
</DL>
 
415
<HR>
 
416
 
 
417
<A NAME="parseObject(java.lang.String, java.text.ParsePosition)"><!-- --></A><H3>
 
418
parseObject</H3>
 
419
<PRE>
 
420
public java.lang.Object <B>parseObject</B>(java.lang.String&nbsp;str,
 
421
                                    java.text.ParsePosition&nbsp;parsePosition)</PRE>
 
422
<DL>
 
423
<DD>Translates a DRMAA specified time string into a PartialTimestamp object.  This
 
424
 method will parse as far as possible.  Upon completion, the parse position
 
425
 object will contain the index of the last character parsed.
 
426
<P>
 
427
<DD><DL>
 
428
<DT><B>Parameters:</B><DD><CODE>str</CODE> - a DRMAA specified time string<DD><CODE>parsePosition</CODE> - the parse position object
 
429
<DT><B>Returns:</B><DD>a PartialTimestamp object</DL>
 
430
</DD>
 
431
</DL>
 
432
<!-- ========= END OF CLASS DATA ========= -->
 
433
<HR>
 
434
 
 
435
 
 
436
<!-- ======= START OF BOTTOM NAVBAR ====== -->
 
437
<A NAME="navbar_bottom"><!-- --></A>
 
438
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 
439
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 
440
<TR>
 
441
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 
442
<A NAME="navbar_bottom_firstrow"><!-- --></A>
 
443
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 
444
  <TR ALIGN="center" VALIGN="top">
 
445
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 
446
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 
447
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 
448
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 
449
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 
450
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 
451
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 
452
  </TR>
 
453
</TABLE>
 
454
</TD>
 
455
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 
456
</EM>
 
457
</TD>
 
458
</TR>
 
459
 
 
460
<TR>
 
461
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
462
&nbsp;<A HREF="../../../org/ggf/drmaa/PartialTimestamp.html" title="class in org.ggf.drmaa"><B>PREV CLASS</B></A>&nbsp;
 
463
&nbsp;<A HREF="../../../org/ggf/drmaa/ReleaseInconsistentStateException.html" title="class in org.ggf.drmaa"><B>NEXT CLASS</B></A></FONT></TD>
 
464
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
465
  <A HREF="../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 
466
&nbsp;<A HREF="PartialTimestampFormat.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 
467
&nbsp;<SCRIPT type="text/javascript">
 
468
  <!--
 
469
  if(window==top) {
 
470
    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
 
471
  }
 
472
  //-->
 
473
</SCRIPT>
 
474
<NOSCRIPT>
 
475
  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
 
476
</NOSCRIPT>
 
477
 
 
478
</FONT></TD>
 
479
</TR>
 
480
<TR>
 
481
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
482
  SUMMARY:&nbsp;<A HREF="#nested_classes_inherited_from_class_java.text.Format">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 
483
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
484
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 
485
</TR>
 
486
</TABLE>
 
487
<A NAME="skip-navbar_bottom"></A>
 
488
<!-- ======== END OF BOTTOM NAVBAR ======= -->
 
489
 
 
490
<HR>
 
491
 
 
492
</BODY>
 
493
</HTML>