KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > api > xmi > sax > XMIProducer


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */
19 package org.netbeans.api.xmi.sax;
20
21 import org.netbeans.api.xmi.XMIOutputConfig;
22 import org.xml.sax.XMLReader JavaDoc;
23 import java.util.Collection JavaDoc;
24 import javax.jmi.reflect.RefPackage;
25
26 /** Implementation of XMLReader used for producing XMI documents.
27  *
28  * @author Martin Matula
29  * @author Holger Krug
30  * @author Brian Smith
31  */
32 public abstract class XMIProducer implements XMLReader JavaDoc {
33     /** Sets collection of objects to be serialized to XMI.
34      * @param objects Collection of RefObjects to be serialized to XMI.
35      */
36     public abstract void setSource(Collection JavaDoc objects);
37     
38     /** Sets source package extent to be serialized to XMI.
39      * @param extent Extent to be serialized.
40      */
41     public abstract void setSource(RefPackage extent);
42     
43     /** Returns source objects to be serialized to XMI.
44      * @return Collection of RefObjects or RefPackage to be serialized to XMI.
45      */
46     public abstract Object JavaDoc getSource();
47     
48     /** Sets version of XMI to be produced.
49      * Default value is "1.2".
50      * @param xmiVersion Version of XMI.
51      */
52     public abstract void setXmiVersion(String JavaDoc xmiVersion);
53     
54     /** Returns version of XMI to be produced.
55      * @return XMI version.
56      */
57     public abstract String JavaDoc getXmiVersion();
58     
59     /** Returns configuration object of this XMIProducer. Any changes to the returned
60      * object will have immediate effect on the XMIProducer's configuration.
61      */
62     public abstract XMIOutputConfig getConfiguration();
63 }
64
Popular Tags