KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > api > mdr > JMIMapper


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.mdr;
20
21 import org.openide.util.Lookup;
22 import javax.jmi.reflect.RefBaseObject;
23 import java.io.IOException JavaDoc;
24 import java.util.Collection JavaDoc;
25
26 /** JMI mapping utility. Generates JMI interfaces for a given metamodel.
27  * Use {@link #getDefault} method to obtain the default instance.
28  *
29  * @author Martin Matula
30  */
31 public abstract class JMIMapper {
32
33     /** Generates JMI interfaces for the specified object
34      * and the objects contained in it.
35      * @param sf Implementation of {@link JMIStreamFactory} interface.
36      * @param object Top-level object for interface generation. There are two possible kinds of objects that can be passed:
37      * <ul>
38      * <li>RefObject (instance) - interfaces for this instance together with interfaces for all transitively contained instances are generated.</li>
39      * <li>RefPackage (package extent) - interfaces for all instances contained transitively in this package extent are generated.</li>
40      * </ul>
41      * @throws IOException I/O error during interfaces generation.
42      */
43     public abstract void generate(JMIStreamFactory sf, RefBaseObject object) throws IOException JavaDoc;
44     
45     /** Returns the default JMI mapping utility in the system
46      * @return default JMI mapping utility
47      */
48     public static synchronized JMIMapper getDefault() {
49         // [PENDING] simple lookup should be used once the lookup is fixed (currently it does not preserve order)
50 Lookup.Result result = Lookup.getDefault().lookup(
51             new Lookup.Template(JMIMapper.class)
52         );
53         Collection JavaDoc instances = result.allInstances();
54         return (instances.size() > 0 ? (JMIMapper) result.allInstances().iterator().next() : null);
55     }
56 }
57
58
Popular Tags