XMIReader


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;
20  
21  import java.util.Collection  ;
22  import javax.jmi.reflect.RefObject;
23  import javax.jmi.reflect.RefPackage;
24  import javax.jmi.xmi.XmiReader;
25  import javax.jmi.xmi.MalformedXMIException;
26  import java.io.InputStream  ;
27  import java.io.IOException  ;
28  
29  /** Base class for enhanced XMI readers.
30   *
31   * @author Martin Matula
32   * @author Brian Smith
33   */
34  public abstract class XMIReader implements XmiReader {
35      //----------------
36      // public methods
37      //----------------
38  
39      /** Returns configuration object of this XMIReader. Any changes to the returned
40       * object will have immediate effect on the XMIReader's configuration.
41       */
42      public abstract XMIInputConfig getConfiguration();
43      
44      //-------------------------------------------
45      // javax.jmi.xmi.XmiReader interface methods
46      //-------------------------------------------
47      
48      /** Standard JMI method for reading XMI documents from an InputStream.
49       *
50       * @param stream Input stream to be used for reading an XMI document (if
51       * <code>null</code> is passed, XMIReader will try to open a connection to the
52       * spefified URI.
53       *
54       * @param URI URI of the XMI document to be read from. If set to <code>null</code>,
55       * XMIReader will not be able to resolve relative hrefs.
56       * @param extent Target package extent for deserialized objects.
57       * @throws IOException I/O error during reading of XMI document.
58       * @throws MalformedXMIException XMI document contains invalid XMI.
59       * @return Collection of outermost objects read from XMI document.
60       */    
61      public abstract Collection   read(InputStream   stream, String   URI, RefPackage extent) throws IOException  , MalformedXMIException;    
62  
63      /** Standard JMI method for reading XMI documents without URI specified.
64       *
65       * @param URI URI of the XMI document to be read. Cannot be <code>null</code>.
66       * @param extent Target package extent for deserialized objects.
67       * @throws IOException I/O error during reading of XMI document.
68       * @throws MalformedXMIException XMI document contains invalid XMI.
69       * @return Collection of outermost objects read from XMI document.
70       */    
71      public abstract Collection   read(String   URI, RefPackage extent) throws IOException  , MalformedXMIException;
72  }
73
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags