KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * @(#)IClassMetaDataWriter.java
3  *
4  * Copyright (C) 2002-2004 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 store the meta-data in a repository.
34  *
35  * @author Matt Albrecht <a HREF="mailto:groboclown@users.sourceforge.net">groboclown@users.sourceforge.net</a>
36  * @version $Date: 2004/03/09 22:23:58 $
37  * @since December 15, 2002
38  */
39 public interface IClassMetaDataWriter
40 {
41     /**
42      * Writes the given class record and its associated marks for this
43      * Analysis Module to the repository. If class record <tt>cr</tt>
44      * has already been written, another call will overwrite any existing
45      * data.
46      *
47      * @param cr the class record to write to the underlying repository.
48      * @exception IOException thrown if there is an underlying problem, or
49      * if the close method has been executed.
50      * @exception IllegalArgumentException if <tt>cr</tt> is <tt>null</tt>.
51      */
52     public void writeClassRecord( ClassRecord cr )
53             throws IOException JavaDoc;
54     
55     
56     /**
57      * Closes off the writer's connection to the store.
58      *
59      * @exception IOException thrown if there is an underlying problem, or
60      * if the close method has been executed before.
61      */
62     public void close()
63             throws IOException JavaDoc;
64 }
65
66
Popular Tags