All Packages Class Hierarchy This Package Previous Next Index
Class com.oreilly.servlet.multipart.FilePart
java.lang.Object
|
+----com.oreilly.servlet.multipart.Part
|
+----com.oreilly.servlet.multipart.FilePart
- public class FilePart
- extends Part
A FilePart
is an upload part which represents a
INPUT TYPE="file"
form parameter.
- Author:
- Geoff Soutter
-
getContentType()
-
Returns the content type of the file data contained within.
-
getFileName()
- Returns the name that the file was stored with on the remote system,
or
null
if the user didn't enter a file to be uploaded.
-
getInputStream()
- Returns an input stream which contains the contents of the
file supplied.
-
isFile()
- Returns
true
to indicate this part is a file.
-
writeTo(File)
- Write this file part to a file or directory.
-
writeTo(OutputStream)
- Write this file part to the given output stream.
getFileName
public String getFileName()
- Returns the name that the file was stored with on the remote system,
or
null
if the user didn't enter a file to be uploaded.
Note: this is not the same as the name of the form parameter used to
transmit the file; that is available from the getName
method.
- Returns:
- name of file uploaded or
null
.
- See Also:
- getName
getContentType
public String getContentType()
- Returns the content type of the file data contained within.
- Returns:
- content type of the file data.
getInputStream
public InputStream getInputStream()
- Returns an input stream which contains the contents of the
file supplied. If the user didn't enter a file to upload
there will be
0
bytes in the input stream.
- Returns:
- an input stream containing contents of file.
writeTo
public long writeTo(File fileOrDirectory) throws IOException
- Write this file part to a file or directory. If the user
supplied a file, we write it to that file, and if they supplied
a directory, we write it to that directory with the filename
that accompanied it. If this part doesn't contain a file this
method does nothing.
- Returns:
- number of bytes written
- Throws: IOException
- if an input or output exception has occurred.
writeTo
public long writeTo(OutputStream out) throws IOException
- Write this file part to the given output stream. If this part doesn't
contain a file this method does nothing.
- Returns:
- number of bytes written.
- Throws: IOException
- if an input or output exception has occurred.
isFile
public boolean isFile()
- Returns
true
to indicate this part is a file.
- Returns:
- true.
- Overrides:
- isFile in class Part
All Packages Class Hierarchy This Package Previous Next Index