|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.io.InputStream com.enterprisedt.net.ftp.FileTransferInputStream com.enterprisedt.net.ftp.FTPInputStream
public class FTPInputStream
Represents an input stream of bytes coming from an FTP server, permitting the user to download a file by reading the stream. It can only be used for one download, i.e. after the stream is closed it cannot be reopened.
Field Summary |
---|
Fields inherited from class com.enterprisedt.net.ftp.FileTransferInputStream |
---|
closed, monitor, monitorCount, monitorEx, monitorInterval, pos, remoteFile, started |
Constructor Summary | |
---|---|
FTPInputStream(FTPClient client,
java.lang.String remoteFile)
Constructor. |
|
FTPInputStream(FTPClient client,
java.lang.String remoteFile,
long offset)
Constructor. |
Method Summary | |
---|---|
void |
close()
Closes this input stream and releases any system resources associated with the stream. |
void |
mark(int readlimit)
Marks the current position in this input stream. |
boolean |
markSupported()
Tests if this input stream supports the mark and
reset methods. |
int |
read()
Reads the next byte of data from the input stream. |
int |
read(byte[] b,
int off,
int len)
Reads up to len bytes of data from the input stream into an array of bytes. |
void |
reset()
Repositions this stream to the position at the time the mark method was last called on this input stream. |
long |
skip(long n)
Skips over and discards n bytes of data from this input
stream. |
Methods inherited from class com.enterprisedt.net.ftp.FileTransferInputStream |
---|
checkMonitor, getRemoteFile, setMonitor |
Methods inherited from class java.io.InputStream |
---|
available, read |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public FTPInputStream(FTPClient client, java.lang.String remoteFile) throws java.io.IOException, FTPException
client
- connected FTPClient instanceremoteFile
- remote file
java.io.IOException
FTPException
public FTPInputStream(FTPClient client, java.lang.String remoteFile, long offset) throws java.io.IOException, FTPException
client
- connected FTPClient instanceremoteFile
- remote fileoffset
- offset to resume downloading from.
java.io.IOException
FTPException
Method Detail |
---|
public int read() throws java.io.IOException
read
in class java.io.InputStream
java.io.IOException
public int read(byte[] b, int off, int len) throws java.io.IOException
read
in class java.io.InputStream
b
- array to read intooff
- offset into the array to start atlen
- the number of bytes to be read
java.io.IOException
public void close() throws java.io.IOException
close
in interface java.io.Closeable
close
in class java.io.InputStream
java.io.IOException
- if an I/O error occurs.public long skip(long n) throws java.io.IOException
n
bytes of data from this input
stream. The skip
method may, for a variety of reasons, end
up skipping over some smaller number of bytes, possibly 0
.
This may result from any of a number of conditions; reaching end of file
before n
bytes have been skipped is only one possibility.
The actual number of bytes skipped is returned. If n
is
negative, no bytes are skipped.
skip
in class java.io.InputStream
n
- the number of bytes to be skipped.
java.io.IOException
- if the stream does not support seek,
or if some other I/O error occurs.public void mark(int readlimit)
reset
method repositions this stream at the last marked
position so that subsequent reads re-read the same bytes.
mark
in class java.io.InputStream
readlimit
- the maximum limit of bytes that can be read before
the mark position becomes invalid.InputStream.reset()
public void reset() throws java.io.IOException
mark
method was last called on this input stream.
reset
in class java.io.InputStream
java.io.IOException
- if this stream has not been marked or if the
mark has been invalidated.InputStream.mark(int)
,
IOException
public boolean markSupported()
mark
and
reset
methods. Whether or not mark
and
reset
are supported is an invariant property of a
particular input stream instance. The markSupported
method
of InputStream
returns false
.
markSupported
in class java.io.InputStream
true
if this stream instance supports the mark
and reset methods; false
otherwise.InputStream.mark(int)
,
InputStream.reset()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |