KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sourceforge > groboutils > codecoverage > v2 > datastore > IClassMetaDataReader


1 /*
2  * @(#)IClassMetaDataReader.java
3  *
4  * Copyright (C) 2002,2003 Matt Albrecht
5  * groboclown@users.sourceforge.net
6  * http://groboutils.sourceforge.net
7  *
8  * Permission is hereby granted, free of charge, to any person obtaining a
9  * 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 JavaDoc;
30
31
32 /**
33  * Knows how to read class meta-data from the repository.
34  *
35  * @author Matt Albrecht <a HREF="mailto:groboclown@users.sourceforge.net">groboclown@users.sourceforge.net</a>
36  * @version $Date: 2004/04/15 05:48:26 $
37  * @since December 15, 2002
38  */
39 public interface IClassMetaDataReader
40 {
41     /**
42      * Returns the class record for the class with this particular signature.
43      *
44      * @param classSignature the class signature requested for reading in
45      * the class record.
46      * @return the record corresponding to this class, or <tt>null</tt> if
47      * there is no such class signature known.
48      * @exception IOException if there is an underlying error during the read,
49      * or if the reader has been closed.
50      */
51     public ClassRecord readClass( String JavaDoc classSignature )
52             throws IOException JavaDoc;
53     
54     
55     /**
56      * Returns all classes known for this particular data set.
57      *
58      * @return the list of all class signatures that can be read by
59      * <tt>readClass( String )</tt>, but never <tt>null</tt>.
60      * @exception IOException if there was an underlying read error, or if
61      * the reader has been closed.
62      */
63     public String JavaDoc[] getClassSignatures()
64             throws IOException JavaDoc;
65     
66     
67     /**
68      * Closes off the reader's connection to the store.
69      *
70      * @exception IOException if there was an underlying read error, or if
71      * the reader has already been closed.
72      */
73     public void close()
74             throws IOException JavaDoc;
75 }
76
77
Popular Tags