de.uni_hildesheim.sse.monitoring.runtime.wrap

Class InstrumentedFileReader

java.lang.Object

java.io.Reader

java.io.InputStreamReader

java.io.FileReader

de.uni_hildesheim.sse.monitoring.runtime.wrap.InstrumentedFileReader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Readable

public class InstrumentedFileReader
extends java.io.FileReader

Extends the file reader class defined by java in order to obtain information while reading from a file.

Since:

1.00

Version:

1.00

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	inRead1 Stores if we are in a read method with 1 parameter (avoid double recording).
private boolean	inRead3 Stores if we are in a read 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.Reader

lock

Constructor Summary

Constructors

Constructor and Description
InstrumentedFileReader(java.io.File file) Creates a file reader by opening a connection to an actual file, the file named by the File object file in the file system.
InstrumentedFileReader(java.io.FileDescriptor fdObj) Creates a file input stream by using the file descriptor fdObj, which represents an existing connection to an actual file in the file system.
InstrumentedFileReader(java.io.FileDescriptor fdObj, java.lang.String recId) Creates a file input stream by using the file descriptor fdObj, which represents an existing connection to an actual file in the file system.
InstrumentedFileReader(java.io.File file, java.lang.String recId) Creates a file reader by opening a connection to an actual file, the file named by the File object file in the file system.
InstrumentedFileReader(java.lang.String name) Creates a file reader by opening a connection to an actual file, the file named by the path name name in the file system.
InstrumentedFileReader(java.lang.String name, java.lang.String recId) Creates a file reader by opening a connection to an actual file, the file named by the path name name in the file system.

Method Summary

Modifier and Type	Method and Description
int	read() Reads a char from a stream.
int	read(char[] buffer) Reads chars into buffer, at maximum up to the length of the buffer.
int	read(char[] buffer, int off, int len) Reads at maximum len chars into buffer starting at off.

Methods inherited from class java.io.InputStreamReader

close, getEncoding, ready

Methods inherited from class java.io.Reader

mark, markSupported, read, reset, skip

Methods inherited from class java.lang.Object

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

Field Detail

inRead3

private boolean inRead3

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

inRead1

private boolean inRead1

Stores if we are in a read 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

InstrumentedFileReader

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

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

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:

name - the system-dependent file name.

Throws:

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

InstrumentedFileReader

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

Creates a file reader by opening a connection to an actual file, the file named by the File object file in the file system.

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:

file - the file to be opened for reading.

Throws:

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

InstrumentedFileReader

public InstrumentedFileReader(java.io.FileDescriptor fdObj)

Creates a file input stream by using the file descriptor fdObj, which represents an existing connection to an actual file in the file system.

If fdObj is null then a NullPointerException is thrown.

Parameters:

fdObj - the file descriptor to be opened for reading.

InstrumentedFileReader

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

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

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:

name - the system-dependent file name.

recId - the recorder id to aggregate the monitored data for

Throws:

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

InstrumentedFileReader

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

Creates a file reader by opening a connection to an actual file, the file named by the File object file in the file system.

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:

file - the file to be opened for reading.

recId - the recorder id to aggregate the monitored data for

Throws:

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

InstrumentedFileReader

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

Creates a file input stream by using the file descriptor fdObj, which represents an existing connection to an actual file in the file system.

If fdObj is null then a NullPointerException is thrown.

Parameters:

fdObj - the file descriptor to be opened for reading.

recId - the recorder id to aggregate the monitored data for

Method Detail

read

public int read()
         throws java.io.IOException

Reads a char from a stream.

Overrides:

read in class java.io.InputStreamReader

Returns:

the char or -1 at the end of the stream

Throws:

java.io.IOException - in case of any I/O error or problem

read

public int read(char[] buffer)
         throws java.io.IOException

Reads chars into buffer, at maximum up to the length of the buffer.

Overrides:

read in class java.io.Reader

Parameters:

buffer - the char buffer to be modified

Returns:

the number of bytes read, negative at stream end

Throws:

java.io.IOException - in case of I/O reading errors

read

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

Reads at maximum len chars into buffer starting at off.

Overrides:

read in class java.io.InputStreamReader

Parameters:

buffer - the char buffer to be modified

off - the offset where to start storing bytes

len - the maximum number of bytes to be read (less than length of b)

Returns:

the number of bytes read, negative at stream end

Throws:

java.io.IOException - in case of I/O reading errors