← Back to branch summary

~ubuntu-branches/ubuntu/lucid/commons-httpclient/lucid

« back to all changes in this revision

Viewing changes to docs/apidocs/org/apache/commons/httpclient/methods/multipart/PartSource.html

  • Committer: Bazaar Package Importer
  • Author(s): Barry Hawkins
  • Date: 2005-11-25 13:12:23 UTC
  • Revision ID: james.westby@ubuntu.com-20051125131223-2g7eyo21pqgrohpo
Tags: upstream-2.0.2
Import upstream version 2.0.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/apidocs/org/apache/commons/httpclient/methods/multipart/PartSource.html
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
 
2
<!--NewPage-->
 
3
<HTML>
 
4
<HEAD>
 
5
<!-- Generated by javadoc on Sun Oct 10 17:41:05 EDT 2004 -->
 
6
<TITLE>
 
7
HttpClient 2.0.2 API: Interface  PartSource
 
8
</TITLE>
 
9
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
 
10
</HEAD>
 
11
<BODY BGCOLOR="white">
 
12
 
 
13
<!-- ========== START OF NAVBAR ========== -->
 
14
<A NAME="navbar_top"><!-- --></A>
 
15
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
 
16
<TR>
 
17
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 
18
<A NAME="navbar_top_firstrow"><!-- --></A>
 
19
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
 
20
  <TR ALIGN="center" VALIGN="top">
 
21
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 
22
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 
23
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 
24
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/PartSource.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 
25
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 
26
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 
27
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 
28
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 
29
  </TR>
 
30
</TABLE>
 
31
</TD>
 
32
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 
33
</EM>
 
34
</TD>
 
35
</TR>
 
36
 
 
37
<TR>
 
38
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
39
&nbsp;PREV CLASS&nbsp;
 
40
&nbsp;NEXT CLASS</FONT></TD>
 
41
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
42
  <A HREF="../../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
 
43
&nbsp;<A HREF="PartSource.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
 
44
</TR>
 
45
<TR>
 
46
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
47
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 
48
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
49
DETAIL: &nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 
50
</TR>
 
51
</TABLE>
 
52
<!-- =========== END OF NAVBAR =========== -->
 
53
 
 
54
<HR>
 
55
<!-- ======== START OF CLASS DATA ======== -->
 
56
<H2>
 
57
<FONT SIZE="-1">
 
58
org.apache.commons.httpclient.methods.multipart</FONT>
 
59
<BR>
 
60
Interface  PartSource</H2>
 
61
<DL>
 
62
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../../org/apache/commons/httpclient/methods/multipart/ByteArrayPartSource.html">ByteArrayPartSource</A>, <A HREF="../../../../../../org/apache/commons/httpclient/methods/multipart/FilePartSource.html">FilePartSource</A></DD>
 
63
</DL>
 
64
<HR>
 
65
<DL>
 
66
<DT>public interface <B>PartSource</B></DL>
 
67
 
 
68
<P>
 
69
An interface for providing access to data when posting MultiPart messages.
 
70
<P>
 
71
<DL>
 
72
<DT><B>Since: </B><DD>2.0</DD>
 
73
<DT><B>Author: </B><DD><a href="mailto:becke@u.washington.edu">Michael Becke</a></DD>
 
74
<DT><B>See Also: </B><DD><A HREF="../../../../../../org/apache/commons/httpclient/methods/multipart/FilePart.html"><CODE>FilePart</CODE></A></DL>
 
75
<HR>
 
76
 
 
77
<P>
 
78
<!-- ======== INNER CLASS SUMMARY ======== -->
 
79
 
 
80
 
 
81
<!-- =========== FIELD SUMMARY =========== -->
 
82
 
 
83
 
 
84
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
 
85
 
 
86
 
 
87
<!-- ========== METHOD SUMMARY =========== -->
 
88
 
 
89
<A NAME="method_summary"><!-- --></A>
 
90
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
91
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
92
<TD COLSPAN=2><FONT SIZE="+2">
 
93
<B>Method Summary</B></FONT></TD>
 
94
</TR>
 
95
<TR BGCOLOR="white" CLASS="TableRowColor">
 
96
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
97
<CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/io/InputStream.html">InputStream</A></CODE></FONT></TD>
 
98
<TD><CODE><B><A HREF="../../../../../../org/apache/commons/httpclient/methods/multipart/PartSource.html#createInputStream()">createInputStream</A></B>()</CODE>
 
99
 
 
100
<BR>
 
101
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets a new InputStream for reading this source.</TD>
 
102
</TR>
 
103
<TR BGCOLOR="white" CLASS="TableRowColor">
 
104
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
105
<CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
 
106
<TD><CODE><B><A HREF="../../../../../../org/apache/commons/httpclient/methods/multipart/PartSource.html#getFileName()">getFileName</A></B>()</CODE>
 
107
 
 
108
<BR>
 
109
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the name of the file this source represents.</TD>
 
110
</TR>
 
111
<TR BGCOLOR="white" CLASS="TableRowColor">
 
112
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
113
<CODE>&nbsp;long</CODE></FONT></TD>
 
114
<TD><CODE><B><A HREF="../../../../../../org/apache/commons/httpclient/methods/multipart/PartSource.html#getLength()">getLength</A></B>()</CODE>
 
115
 
 
116
<BR>
 
117
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the number of bytes contained in this source.</TD>
 
118
</TR>
 
119
</TABLE>
 
120
&nbsp;
 
121
<P>
 
122
 
 
123
<!-- ============ FIELD DETAIL =========== -->
 
124
 
 
125
 
 
126
<!-- ========= CONSTRUCTOR DETAIL ======== -->
 
127
 
 
128
 
 
129
<!-- ============ METHOD DETAIL ========== -->
 
130
 
 
131
<A NAME="method_detail"><!-- --></A>
 
132
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
133
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
134
<TD COLSPAN=1><FONT SIZE="+2">
 
135
<B>Method Detail</B></FONT></TD>
 
136
</TR>
 
137
</TABLE>
 
138
 
 
139
<A NAME="getLength()"><!-- --></A><H3>
 
140
getLength</H3>
 
141
<PRE>
 
142
public long <B>getLength</B>()</PRE>
 
143
<DL>
 
144
<DD>Gets the number of bytes contained in this source.<DD><DL>
 
145
<DT><B>Returns:</B><DD>a value >= 0</DL>
 
146
</DD>
 
147
</DL>
 
148
<HR>
 
149
 
 
150
<A NAME="getFileName()"><!-- --></A><H3>
 
151
getFileName</H3>
 
152
<PRE>
 
153
public <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> <B>getFileName</B>()</PRE>
 
154
<DL>
 
155
<DD>Gets the name of the file this source represents.<DD><DL>
 
156
<DT><B>Returns:</B><DD>the fileName used for posting a MultiPart file part</DL>
 
157
</DD>
 
158
</DL>
 
159
<HR>
 
160
 
 
161
<A NAME="createInputStream()"><!-- --></A><H3>
 
162
createInputStream</H3>
 
163
<PRE>
 
164
public <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/io/InputStream.html">InputStream</A> <B>createInputStream</B>()
 
165
                              throws <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/io/IOException.html">IOException</A></PRE>
 
166
<DL>
 
167
<DD>Gets a new InputStream for reading this source.  This method can be 
 
168
 called more than once and should therefore return a new stream every
 
169
 time.<DD><DL>
 
170
<DT><B>Returns:</B><DD>a new InputStream<DT><B>Throws:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/io/IOException.html">IOException</A></CODE> - if an error occurs when creating the InputStream</DL>
 
171
</DD>
 
172
</DL>
 
173
<!-- ========= END OF CLASS DATA ========= -->
 
174
<HR>
 
175
 
 
176
<!-- ========== START OF NAVBAR ========== -->
 
177
<A NAME="navbar_bottom"><!-- --></A>
 
178
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
 
179
<TR>
 
180
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 
181
<A NAME="navbar_bottom_firstrow"><!-- --></A>
 
182
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
 
183
  <TR ALIGN="center" VALIGN="top">
 
184
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 
185
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 
186
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 
187
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/PartSource.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 
188
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 
189
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 
190
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 
191
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 
192
  </TR>
 
193
</TABLE>
 
194
</TD>
 
195
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 
196
</EM>
 
197
</TD>
 
198
</TR>
 
199
 
 
200
<TR>
 
201
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
202
&nbsp;PREV CLASS&nbsp;
 
203
&nbsp;NEXT CLASS</FONT></TD>
 
204
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
205
  <A HREF="../../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
 
206
&nbsp;<A HREF="PartSource.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
 
207
</TR>
 
208
<TR>
 
209
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
210
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 
211
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
212
DETAIL: &nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 
213
</TR>
 
214
</TABLE>
 
215
<!-- =========== END OF NAVBAR =========== -->
 
216
 
 
217
<HR>
 
218
Copyright &copy; 2001-2004 Apache Software Foundation. All Rights Reserved.
 
219
</BODY>
 
220
</HTML>