com.enterprisedt.net.ftp

Class FTPOutputStream

java.lang.Object

java.io.OutputStream

com.enterprisedt.net.ftp.FileTransferOutputStream

com.enterprisedt.net.ftp.FTPOutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public class FTPOutputStream
extends FileTransferOutputStream

Represents an output stream that writes to an FTP server, permitting the user to upload a file by writing to the stream. It can only be used for one upload, i.e. after the stream is closed it cannot be reopened.

Version:

$Revision: 1.3 $

Author:

Bruce Blackshaw

Field Summary

Fields inherited from class com.enterprisedt.net.ftp.FileTransferOutputStream

closed, remoteFile, size

Constructor Summary

Constructors

Constructor and Description
FTPOutputStream(FTPClient client, java.lang.String remoteFile) Constructor.
FTPOutputStream(FTPClient client, java.lang.String remoteFile, boolean append) Constructor.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this output stream and releases any system resources associated with the stream.
void	setMonitor(FTPProgressMonitorEx monitor, long monitorInterval) The output stream uses the progress monitor currently owned by the FTP client.
void	write(byte[] b, int off, int len) Writes len bytes from the specified byte array starting at offset off to this output stream.
void	write(int b) Writes b.length bytes from the specified byte array to this output stream.

Methods inherited from class com.enterprisedt.net.ftp.FileTransferOutputStream

getBytesTransferred, getRemoteFile

Methods inherited from class java.io.OutputStream

flush, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FTPOutputStream

public FTPOutputStream(FTPClient client,
                       java.lang.String remoteFile)
                throws java.io.IOException,
                       FTPException

Constructor. A connected FTPClient instance must be supplied. This sets up the download.

Parameters:

client - connected FTPClient instance (or subclass)

remoteFile - name of remote file (if null, the server may be able to generate a name

Throws:

java.io.IOException

FTPException

FTPOutputStream

public FTPOutputStream(FTPClient client,
                       java.lang.String remoteFile,
                       boolean append)
                throws java.io.IOException,
                       FTPException

Constructor. A connected FTPClient instance must be supplied. This sets up the download.

Parameters:

client - connected FTPClient instance (or subclass)

remoteFile - name of remote file (if null, the server may be able to generate a name

append - true if appending on the server

Throws:

java.io.IOException

FTPException

Method Detail

setMonitor

public void setMonitor(FTPProgressMonitorEx monitor,
                       long monitorInterval)

The output stream uses the progress monitor currently owned by the FTP client. This method allows a different progress monitor to be passed in, or for the monitor interval to be altered.

Parameters:

monitor - progress monitor reference

monitorInterval -

write

public void write(int b)
           throws java.io.IOException

Writes b.length bytes from the specified byte array to this output stream.

Specified by:

write in class java.io.OutputStream

Parameters:

b - the data.

Throws:

java.io.IOException - if an I/O error occurs.

write

public void write(byte[] b,
                  int off,
                  int len)
           throws java.io.IOException

Writes len bytes from the specified byte array starting at offset off to this output stream.

Overrides:

write in class java.io.OutputStream

Parameters:

b - the data.

off - the start offset in the data.

len - the number of bytes to write.

Throws:

java.io.IOException - if an I/O error occurs.

close

public void close()
           throws java.io.IOException

Closes this output stream and releases any system resources associated with the stream. This must be called before any other operations are initiated on the FTPClient.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.OutputStream

Throws:

java.io.IOException - if an I/O error occurs.