net.sourceforge.groboutils.codecoverage.v2.datastore
Interface IClassMetaDataReader

All Known Implementing Classes:

DirClassMetaDataReader

public interface IClassMetaDataReader

Knows how to read class meta-data from the repository.

Since:

December 15, 2002

Version:

$Date: 2003/02/10 22:51:27 $

Author:

Matt Albrecht groboclown@users.sourceforge.net

Method Summary

void	close() Closes off the reader's connection to the store.
java.lang.String[]	getClassSignatures() Returns all classes known for this particular data set.
ClassRecord	readClass(java.lang.String classSignature) Returns the class record for the class with this particular signature.

Method Detail

readClass

public ClassRecord readClass(java.lang.String classSignature)
                      throws java.io.IOException

Returns the class record for the class with this particular signature.

Parameters:

classSignature - the class signature requested for reading in the class record.

Returns:

the record corresponding to this class, or null if there is no such class signature known.

Throws:

java.io.IOException - if there is an underlying error during the read, or if the reader has been closed.

getClassSignatures

public java.lang.String[] getClassSignatures()
                                      throws java.io.IOException

Returns all classes known for this particular data set.

Returns:

the list of all class signatures that can be read by readClass( String ), but never null.

Throws:

java.io.IOException - if there was an underlying read error, or if the reader has been closed.

close

public void close()
           throws java.io.IOException

Closes off the reader's connection to the store.

Throws:

java.io.IOException - if there was an underlying read error, or if the reader has already been closed.