de.uni_hildesheim.sse.monitoring.runtime.wrap

Class InstrumentedFileWriter

java.lang.Object

java.io.Writer

java.io.OutputStreamWriter

java.io.FileWriter

de.uni_hildesheim.sse.monitoring.runtime.wrap.InstrumentedFileWriter

All Implemented Interfaces:

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

public class InstrumentedFileWriter
extends java.io.FileWriter

Extends the file writer 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.

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
InstrumentedFileWriter(java.io.File file) Constructs a file writer object given a File object.
InstrumentedFileWriter(java.io.File file, boolean append) Constructs a file writer object given a File object.
InstrumentedFileWriter(java.io.File file, boolean append, java.lang.String recId) Constructs a file writer object given a File object.
InstrumentedFileWriter(java.io.FileDescriptor fdObj) Constructs a FileWriter object associated with a file descriptor.
InstrumentedFileWriter(java.io.FileDescriptor fdObj, java.lang.String recId) Constructs a FileWriter object associated with a file descriptor.
InstrumentedFileWriter(java.io.File file, java.lang.String recId) Constructs a file writer object given a File object.
InstrumentedFileWriter(java.lang.String name) Creates a file writer to write to the file with the specified name.
InstrumentedFileWriter(java.lang.String name, boolean append) Constructs a file writer object given a file name with a boolean indicating whether or not to append the data written.
InstrumentedFileWriter(java.lang.String name, boolean append, java.lang.String recId) Constructs a file writer object given a file name with a boolean indicating whether or not to append the data written.
InstrumentedFileWriter(java.lang.String name, java.lang.String recId) Creates a file writer to write to the file with the specified name.

Method Summary

Modifier and Type	Method and Description
void	write(char[] buffer) Writes a data array.
void	write(char[] buffer, int off, int len) Writes a portion of a data array.
void	write(int value) Writes a char to the writer.
void	write(java.lang.String str, int off, int len) Writes a portion of a string.

Methods inherited from class java.io.OutputStreamWriter

close, flush, getEncoding

Methods inherited from class java.io.Writer

append, append, append, write

Methods inherited from class java.lang.Object

clone, equals, finalize, 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

InstrumentedFileWriter

public InstrumentedFileWriter(java.lang.String name)
                       throws java.io.IOException

Creates a file writer 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.IOException - 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

InstrumentedFileWriter

public InstrumentedFileWriter(java.lang.String name,
                              boolean append)
                       throws java.io.IOException

Constructs a file writer object given a file name with a boolean indicating whether or not to append the data written.

Parameters:

name - String The system-dependent filename.

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

Throws:

java.io.IOException - if the named 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

InstrumentedFileWriter

public InstrumentedFileWriter(java.io.File file)
                       throws java.io.IOException

Constructs a file writer object given a File object.

Parameters:

file - a File object to write to.

Throws:

java.io.IOException - 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

InstrumentedFileWriter

public InstrumentedFileWriter(java.io.File file,
                              boolean append)
                       throws java.io.IOException

Constructs a file writer object given a File object. If the second argument is true, then bytes will be written to the end of the file rather than the beginning.

Parameters:

file - a File object to write to

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

Throws:

java.io.IOException - 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

InstrumentedFileWriter

public InstrumentedFileWriter(java.io.FileDescriptor fdObj)

Constructs a FileWriter object associated with a file descriptor.

Parameters:

fdObj - FileDescriptor object to write to.

InstrumentedFileWriter

public InstrumentedFileWriter(java.lang.String name,
                              java.lang.String recId)
                       throws java.io.IOException

Creates a file writer 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.IOException - 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

InstrumentedFileWriter

public InstrumentedFileWriter(java.lang.String name,
                              boolean append,
                              java.lang.String recId)
                       throws java.io.IOException

Constructs a file writer object given a file name with a boolean indicating whether or not to append the data written.

Parameters:

name - String The system-dependent filename.

append - boolean if true, then data 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.IOException - if the named 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

InstrumentedFileWriter

public InstrumentedFileWriter(java.io.File file,
                              java.lang.String recId)
                       throws java.io.IOException

Constructs a file writer object given a File object.

Parameters:

file - a File object to write to.

recId - the recorder id to aggregate the monitored data for

Throws:

java.io.IOException - 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

InstrumentedFileWriter

public InstrumentedFileWriter(java.io.File file,
                              boolean append,
                              java.lang.String recId)
                       throws java.io.IOException

Constructs a file writer object given a File object. If the second argument is true, then bytes will be written to the end of the file rather than the beginning.

Parameters:

file - a File object to write to

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

InstrumentedFileWriter

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

Constructs a FileWriter object associated with a file descriptor.

Parameters:

fdObj - FileDescriptor object to write to.

recId - the recorder id to aggregate the monitored data for

Method Detail

write

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

Writes a char to the writer.

Overrides:

write in class java.io.OutputStreamWriter

Parameters:

value - the char

Throws:

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

write

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

Writes a data array.

Overrides:

write in class java.io.Writer

Parameters:

buffer - the data array

Throws:

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

write

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

Writes a portion of a data array.

Overrides:

write in class java.io.OutputStreamWriter

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

write

public void write(java.lang.String str,
                  int off,
                  int len)
           throws java.io.IOException

Writes a portion of a string.

Overrides:

write in class java.io.OutputStreamWriter

Parameters:

str - A String

off - Offset from which to start writing characters

len - Number of characters to write

Throws:

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