de.uni_hildesheim.sse.monitoring.runtime.wrap

Class InstrumentedFileOutputStream

java.lang.Object

java.io.OutputStream

java.io.FileOutputStream

de.uni_hildesheim.sse.monitoring.runtime.wrap.InstrumentedFileOutputStream

All Implemented Interfaces:

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

public class InstrumentedFileOutputStream
extends java.io.FileOutputStream

Extends the file output stream class defined by java in order to obtain information while writing to a file.

Since:

1.00

Version:

1.00

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	inWrite1 Stores if we are in a write method with 1 parameter (avoid double recording).
private boolean	inWrite3 Stores if we are in a write method with 3 parameters (avoid double recording).
private java.lang.String	recId Stores the recorder id to aggregate the monitored data for.

Constructor Summary

Constructors

Constructor and Description
InstrumentedFileOutputStream(java.io.File file) Creates a file output stream to write to the file represented by the specified File object.
InstrumentedFileOutputStream(java.io.File file, boolean append) Creates a file output stream to write to the file represented by the specified File object.
InstrumentedFileOutputStream(java.io.File file, boolean append, java.lang.String recId) Creates a file output stream to write to the file represented by the specified File object.
InstrumentedFileOutputStream(java.io.FileDescriptor fdObj) Creates an output file stream to write to the specified file descriptor, which represents an existing connection to an actual file in the file system.
InstrumentedFileOutputStream(java.io.FileDescriptor fdObj, java.lang.String recId) Creates an output file stream to write to the specified file descriptor, which represents an existing connection to an actual file in the file system.
InstrumentedFileOutputStream(java.io.File file, java.lang.String recId) Creates a file output stream to write to the file represented by the specified File object.
InstrumentedFileOutputStream(java.lang.String name) Creates an output file stream to write to the file with the specified name.
InstrumentedFileOutputStream(java.lang.String name, boolean append) Creates an output file stream to write to the file with the specified name.
InstrumentedFileOutputStream(java.lang.String name, boolean append, java.lang.String recId) Creates an output file stream to write to the file with the specified name.
InstrumentedFileOutputStream(java.lang.String name, java.lang.String recId) Creates an output file stream to write to the file with the specified name.

Method Summary

Modifier and Type	Method and Description
void	write(byte[] buffer) Writes a data array.
void	write(byte[] buffer, int off, int len) Writes a portion of a data array.
void	write(int value) Writes a byte to the stream.

Methods inherited from class java.io.FileOutputStream

close, finalize, getChannel, getFD

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

inWrite3

private boolean inWrite3

Stores if we are in a write method with 3 parameters (avoid double recording).

inWrite1

private boolean inWrite1

Stores if we are in a write method with 1 parameter (avoid double recording).

recId

private java.lang.String recId

Stores the recorder id to aggregate the monitored data for.

Constructor Detail

InstrumentedFileOutputStream

public InstrumentedFileOutputStream(java.lang.String name)
                             throws java.io.FileNotFoundException

Creates an output file stream to write to the file with the specified name. A new FileDescriptor object is created to represent this file connection.

If the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason then a FileNotFoundException is thrown.

Parameters:

name - the system-dependent filename

Throws:

java.io.FileNotFoundException - if the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason

InstrumentedFileOutputStream

public InstrumentedFileOutputStream(java.lang.String name,
                                    boolean append)
                             throws java.io.FileNotFoundException

Creates an output file stream to write to the file with the specified name. If the second argument is true, then bytes will be written to the end of the file rather than the beginning. A new FileDescriptor object is created to represent this file connection.

If the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason then a FileNotFoundException is thrown.

Parameters:

name - the system-dependent file name

append - if true, then bytes will be written to the end of the file rather than the beginning

Throws:

java.io.FileNotFoundException - if the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason.

InstrumentedFileOutputStream

public InstrumentedFileOutputStream(java.io.File file)
                             throws java.io.FileNotFoundException

Creates a file output stream to write to the file represented by the specified File object. A new FileDescriptor object is created to represent this file connection.

If the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason then a FileNotFoundException is thrown.

Parameters:

file - the file to be opened for writing.

Throws:

java.io.FileNotFoundException - if the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason

InstrumentedFileOutputStream

public InstrumentedFileOutputStream(java.io.File file,
                                    boolean append)
                             throws java.io.FileNotFoundException

Creates a file output stream to write to the file represented by the specified File object. If the second argument is true, then bytes will be written to the end of the file rather than the beginning. A new FileDescriptor object is created to represent this file connection.

If the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason then a FileNotFoundException is thrown.

Parameters:

file - the file to be opened for writing.

append - if true, then bytes will be written to the end of the file rather than the beginning

Throws:

java.io.FileNotFoundException - if the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason

InstrumentedFileOutputStream

public InstrumentedFileOutputStream(java.io.FileDescriptor fdObj)

Creates an output file stream to write to the specified file descriptor, which represents an existing connection to an actual file in the file system.

Parameters:

fdObj - the file descriptor to be opened for writing

InstrumentedFileOutputStream

public InstrumentedFileOutputStream(java.lang.String name,
                                    java.lang.String recId)
                             throws java.io.FileNotFoundException

Creates an output file stream to write to the file with the specified name. A new FileDescriptor object is created to represent this file connection.

If the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason then a FileNotFoundException is thrown.

Parameters:

name - the system-dependent filename

recId - the recorder id to aggregate the monitored data for

Throws:

java.io.FileNotFoundException - if the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason

InstrumentedFileOutputStream

public InstrumentedFileOutputStream(java.lang.String name,
                                    boolean append,
                                    java.lang.String recId)
                             throws java.io.FileNotFoundException

Creates an output file stream to write to the file with the specified name. If the second argument is true, then bytes will be written to the end of the file rather than the beginning. A new FileDescriptor object is created to represent this file connection.

If the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason then a FileNotFoundException is thrown.

Parameters:

name - the system-dependent file name

append - if true, then bytes will be written to the end of the file rather than the beginning

recId - the recorder id to aggregate the monitored data for

Throws:

java.io.FileNotFoundException - if the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason.

InstrumentedFileOutputStream

public InstrumentedFileOutputStream(java.io.File file,
                                    java.lang.String recId)
                             throws java.io.FileNotFoundException

Creates a file output stream to write to the file represented by the specified File object. A new FileDescriptor object is created to represent this file connection.

If the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason then a FileNotFoundException is thrown.

Parameters:

file - the file to be opened for writing.

recId - the recorder id to aggregate the monitored data for

Throws:

java.io.FileNotFoundException - if the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason

InstrumentedFileOutputStream

public InstrumentedFileOutputStream(java.io.File file,
                                    boolean append,
                                    java.lang.String recId)
                             throws java.io.FileNotFoundException

Creates a file output stream to write to the file represented by the specified File object. If the second argument is true, then bytes will be written to the end of the file rather than the beginning. A new FileDescriptor object is created to represent this file connection.

If the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason then a FileNotFoundException is thrown.

Parameters:

file - the file to be opened for writing.

append - if true, then bytes will be written to the end of the file rather than the beginning

recId - the recorder id to aggregate the monitored data for

Throws:

java.io.FileNotFoundException - if the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason

InstrumentedFileOutputStream

public InstrumentedFileOutputStream(java.io.FileDescriptor fdObj,
                                    java.lang.String recId)

Creates an output file stream to write to the specified file descriptor, which represents an existing connection to an actual file in the file system.

Parameters:

fdObj - the file descriptor to be opened for writing

recId - the recorder id to aggregate the monitored data for

Method Detail

write

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

Writes a byte to the stream.

Overrides:

write in class java.io.FileOutputStream

Parameters:

value - the data byte

Throws:

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

write

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

Writes a data array.

Overrides:

write in class java.io.FileOutputStream

Parameters:

buffer - the data array

Throws:

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

write

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

Writes a portion of a data array.

Overrides:

write in class java.io.FileOutputStream

Parameters:

buffer - the data array

off - Offset from which to start writing characters

len - Number of characters to write

Throws:

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