KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > api > xmi > XMIInputConfig


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 /** Configuration class for objects taking XMI as input (e.g. {@link XMIReader}).
22  *
23  * @author Martin Matula
24  * @author Brian Smith
25  */
26 public abstract class XMIInputConfig {
27     /** Sets reference resolver to be used for resolving hrefs when reading XMI.
28      * XMIReader/Consumer should call {@link XMIReferenceResolver#register} for each
29      * object deserialized from XMI that has an xmi id associated with it.
30      * At the end of the XMI document, the XMI reader/consumer should call
31      * {@link XMIReferenceResolver#resolve} passing all of unresolved
32      * external references (hrefs).
33      * For immutable configurations this method throws
34      * <code>UnsupportedOperationException</code>.
35      * @param resolver Resolver to be used.
36      */
37     public abstract void setReferenceResolver(XMIReferenceResolver resolver);
38     
39     /** Returns a reference resolver to be used.
40      * This method should never return <code>null</code> for a configuration
41      * associated with an XMIReader/Consumer. Otherwise if
42      * <code>null</CODE> is returned, the default reference resolver
43      * will be used.
44      * @return Reference resolver to be used or <code>null</code>.
45      */
46     public abstract XMIReferenceResolver getReferenceResolver();
47 }
48
Popular Tags