com.emc.ecs.nfsclient.nfs.io

Class NfsFileInputStream

java.lang.Object

java.io.InputStream

com.emc.ecs.nfsclient.nfs.io.NfsFileInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class NfsFileInputStream
extends java.io.InputStream

The NFS equivalent of java.io.FileInputStream.

Field Summary

Fields

Modifier and Type	Field and Description
static int	EOF Constant for output.

Constructor Summary

Constructors

Constructor and Description
NfsFileInputStream(NfsFile<?,?> nfsFile) Creates a NfsFileInputStream by opening a connection to an actual NFS file, starting to read at offset 0 and using the preferred buffer size as the maximums.
NfsFileInputStream(NfsFile<?,?> nfsFile, int maximumBufferSize) Creates a NfsFileInputStream by opening a connection to an actual NFS file, starting to read at offset 0 and using the specified maximum buffer size.
NfsFileInputStream(NfsFile<?,?> nfsFile, long offset, int maximumBufferSize) Creates a NfsFileInputStream by opening a connection to an actual NFS file, using the specified offset and maximumBufferSize.

Method Summary

Modifier and Type	Method and Description
int	available()
void	close()
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
void	reset()
long	skip(long bytesToSkip)

Methods inherited from class java.lang.Object

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

Field Detail

EOF

public static final int EOF

Constant for output.

See Also:

Constant Field Values

Constructor Detail

NfsFileInputStream

public NfsFileInputStream(NfsFile<?,?> nfsFile,
                          long offset,
                          int maximumBufferSize)
                   throws java.io.IOException

Creates a NfsFileInputStream by opening a connection to an actual NFS file, using the specified offset and maximumBufferSize.

If the named file does not exist, is a directory rather than a regular file, or for some other reason cannot be opened for reading then a FileNotFoundException is thrown.

Parameters:

nfsFile - The NFS file instance to be read.

offset - The offset at which reading should start, in bytes.

maximumBufferSize - The maximum buffer size to use in bytes.

Throws:

java.io.IOException - If the file does not exist, is a directory rather than a regular file, or for some other reason cannot be opened for reading.

NfsFileInputStream

public NfsFileInputStream(NfsFile<?,?> nfsFile,
                          int maximumBufferSize)
                   throws java.io.IOException

Creates a NfsFileInputStream by opening a connection to an actual NFS file, starting to read at offset 0 and using the specified maximum buffer size.

If the named file does not exist, is a directory rather than a regular file, or for some other reason cannot be opened for reading then a FileNotFoundException is thrown.

Parameters:

nfsFile - The NFS file instance to be read.

maximumBufferSize - The maximum buffer size to use in bytes.

Throws:

java.io.IOException - If the file does not exist, is a directory rather than a regular file, or for some other reason cannot be opened for reading.

NfsFileInputStream

public NfsFileInputStream(NfsFile<?,?> nfsFile)
                   throws java.io.IOException

Creates a NfsFileInputStream by opening a connection to an actual NFS file, starting to read at offset 0 and using the preferred buffer size as the maximums. This constructor will generally give you the best performance.

If the named file does not exist, is a directory rather than a regular file, or for some other reason cannot be opened for reading then a FileNotFoundException is thrown.

Parameters:

nfsFile - The NFS file instance to be read.

Throws:

java.io.IOException - If the file does not exist, is a directory rather than a regular file, or for some other reason cannot be opened for reading.

Method Detail

available

public int available()
              throws java.io.IOException

Overrides:

available in class java.io.InputStream

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.InputStream

Throws:

java.io.IOException

mark

public void mark(int readlimit)

Overrides:

mark in class java.io.InputStream

markSupported

public boolean markSupported()

Overrides:

markSupported in class java.io.InputStream

read

public int read()
         throws java.io.IOException

Specified by:

read in class java.io.InputStream

Throws:

java.io.IOException

read

public int read(byte[] b)
         throws java.io.IOException

Overrides:

read in class java.io.InputStream

Throws:

java.io.IOException

read

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

Overrides:

read in class java.io.InputStream

Throws:

java.io.IOException

reset

public void reset()
           throws java.io.IOException

Overrides:

reset in class java.io.InputStream

Throws:

java.io.IOException

skip

public long skip(long bytesToSkip)
          throws java.io.IOException

Overrides:

skip in class java.io.InputStream

Throws:

java.io.IOException