01: /*
02: * @(#)IClassMetaDataReader.java
03: *
04: * Copyright (C) 2002,2003 Matt Albrecht
05: * groboclown@users.sourceforge.net
06: * http://groboutils.sourceforge.net
07: *
08: * Permission is hereby granted, free of charge, to any person obtaining a
09: * copy of this software and associated documentation files (the "Software"),
10: * to deal in the Software without restriction, including without limitation
11: * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12: * and/or sell copies of the Software, and to permit persons to whom the
13: * Software is furnished to do so, subject to the following conditions:
14: *
15: * The above copyright notice and this permission notice shall be included in
16: * all copies or substantial portions of the Software.
17: *
18: * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19: * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20: * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21: * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22: * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23: * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
24: * DEALINGS IN THE SOFTWARE.
25: */
26:
27: package net.sourceforge.groboutils.codecoverage.v2.datastore;
28:
29: import java.io.IOException;
30:
31: /**
32: * Knows how to read class meta-data from the repository.
33: *
34: * @author Matt Albrecht <a href="mailto:groboclown@users.sourceforge.net">groboclown@users.sourceforge.net</a>
35: * @version $Date: 2004/04/15 05:48:26 $
36: * @since December 15, 2002
37: */
38: public interface IClassMetaDataReader {
39: /**
40: * Returns the class record for the class with this particular signature.
41: *
42: * @param classSignature the class signature requested for reading in
43: * the class record.
44: * @return the record corresponding to this class, or <tt>null</tt> if
45: * there is no such class signature known.
46: * @exception IOException if there is an underlying error during the read,
47: * or if the reader has been closed.
48: */
49: public ClassRecord readClass(String classSignature)
50: throws IOException;
51:
52: /**
53: * Returns all classes known for this particular data set.
54: *
55: * @return the list of all class signatures that can be read by
56: * <tt>readClass( String )</tt>, but never <tt>null</tt>.
57: * @exception IOException if there was an underlying read error, or if
58: * the reader has been closed.
59: */
60: public String[] getClassSignatures() throws IOException;
61:
62: /**
63: * Closes off the reader's connection to the store.
64: *
65: * @exception IOException if there was an underlying read error, or if
66: * the reader has already been closed.
67: */
68: public void close() throws IOException;
69: }
|