Class NfsFileInputStream

java.lang.Object

java.io.InputStream

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

All Implemented Interfaces:

Closeable, AutoCloseable

public class NfsFileInputStream
extends InputStream

The NFS equivalent of java.io.FileInputStream.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	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	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 InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class Object

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

Field Details

EOF

public static final int EOF

Constant for output.

See Also:

• Constant Field Values

Constructor Details

NfsFileInputStream

public NfsFileInputStream(NfsFile<?,?> nfsFile,
 long offset,
 int maximumBufferSize)
                   throws 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:

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 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:

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 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:

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 Details

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

Throws:

IOException

mark

public void mark(int readlimit)

Overrides:

mark in class InputStream

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

read

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

Overrides:

read in class InputStream

Throws:

IOException

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

IOException

skip

public long skip(long bytesToSkip)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException