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