edu.sdsc.grid.io
Class GeneralFileOutputStream

java.lang.Object
  java.io.OutputStream
      edu.sdsc.grid.io.GeneralFileOutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable

Direct Known Subclasses:

LocalFileOutputStream, RemoteFileOutputStream

public abstract class GeneralFileOutputStream
extends java.io.OutputStream

A GeneralFileOutputStream writes bytes to a file in a file system. What files are available depends on the host environment.

GeneralFileOutputStream is meant for writing streams of raw bytes such as image data.

The original intention for this class was to subclass java.io.FileOuputStream. But that is not currently the case.

Since:

JARGON1.4

Field Summary

protected int

fd Holds the file descriptor information used by this stream.

Constructor Summary

GeneralFileOutputStream(GeneralFile file)
Creates a FileInputStream by opening a connection to an actual file, the file named by the File object file in the file system.

GeneralFileOutputStream(GeneralFileSystem fileSystem, java.lang.String name)
Creates a FileOuputStream by opening a connection to an actual file, the file named by the path name name in the file system.

Method Summary

abstract void	close() Closes this file output stream and releases any system resources associated with this stream.
protected void	finalize() Ensures that the close method of this file input stream is called when there are no more references to it.
protected abstract void	open(GeneralFile file) Opens the given file for use by this stream.
void	write(byte[] b) Writes b.length bytes from the specified byte array to this file output stream.
abstract void	write(byte[] b, int off, int len) Writes len bytes from the specified byte array starting at offset off to this file output stream.
void	write(int b) Writes the specified byte to this file output stream.

Methods inherited from class java.io.OutputStream

flush

Methods inherited from class java.lang.Object

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

Field Detail

fd

protected int fd

Holds the file descriptor information used by this stream.

Constructor Detail

GeneralFileOutputStream

public GeneralFileOutputStream(GeneralFileSystem fileSystem,
                               java.lang.String name)
                        throws java.io.IOException

Creates a FileOuputStream by opening a connection to an actual file, the file named by the path name name in the file system.

First, the security is checked to verify the file can be written.

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 IOException is thrown.

Parameters:

name - the system-dependent file name.

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.

GeneralFileOutputStream

public GeneralFileOutputStream(GeneralFile file)
                        throws java.io.IOException

Creates a FileInputStream by opening a connection to an actual file, the file named by the File object file in the file system. A new FileDescriptor object is created to represent this file connection.

First, the security is checked to verify the file can be written.

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 IOException is thrown.

Parameters:

file - the file to be opened for reading.

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.

See Also:

File.getPath()

Method Detail

finalize

protected void finalize()
                 throws java.io.IOException

Ensures that the close method of this file input stream is called when there are no more references to it.

Overrides:

finalize in class java.lang.Object

Throws:

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

See Also:

close()

open

protected abstract void open(GeneralFile file)
                      throws java.io.IOException

Opens the given file for use by this stream.

Parameters:

file - the file to be opened.

Throws:

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

write

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

Writes the specified byte to this file output stream. Implements the write method of OutputStream.

Specified by:

write in class java.io.OutputStream

Parameters:

b - the byte to be written.

Throws:

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

write

public void write(byte[] b)
           throws java.io.IOException

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

Overrides:

write in class java.io.OutputStream

Parameters:

b - the data.

Throws:

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

write

public abstract 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 file 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 abstract void close()
                    throws java.io.IOException

Closes this file output stream and releases any system resources associated with this stream. This file output stream may no longer be used for writing bytes.

If this stream has an associated channel then the channel is closed as well.

Specified by:

close in interface java.io.Closeable

Overrides:

close in class java.io.OutputStream

Throws:

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