01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common Development
08: * and Distribution License("CDDL") (collectively, the "License"). You
09: * may not use this file except in compliance with the License. You can obtain
10: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12: * language governing permissions and limitations under the License.
13: *
14: * When distributing the software, include this License Header Notice in each
15: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16: * Sun designates this particular file as subject to the "Classpath" exception
17: * as provided by Sun in the GPL Version 2 section of the License file that
18: * accompanied this code. If applicable, add the following below the License
19: * Header, with the fields enclosed by brackets [] replaced by your own
20: * identifying information: "Portions Copyrighted [year]
21: * [name of copyright owner]"
22: *
23: * Contributor(s):
24: *
25: * If you wish your version of this file to be governed by only the CDDL or
26: * only the GPL Version 2, indicate your decision by adding "[Contributor]
27: * elects to include this software in this distribution under the [CDDL or GPL
28: * Version 2] license." If you don't indicate a single choice of license, a
29: * recipient has the option to distribute your version of this file under
30: * either the CDDL, the GPL Version 2 or to extend the choice of license to
31: * its licensees as provided above. However, if you add GPL Version 2 code
32: * and therefore, elected the GPL Version 2 license, then the option applies
33: * only if the new code is made subject to such option by the copyright
34: * holder.
35: */
36: package com.sun.tools.xjc.api;
37:
38: import java.util.Collection;
39: import java.util.Map;
40:
41: import javax.xml.namespace.QName;
42:
43: import com.sun.mirror.apt.AnnotationProcessorEnvironment;
44:
45: /**
46: * Java-to-Schema compiler.
47: *
48: * @author
49: * Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
50: */
51: public interface JavaCompiler {
52:
53: /**
54: * Compiles the given annotated Java source code.
55: *
56: * <p>
57: * This operation takes a set of "root types", then compute the list of
58: * all the types that need to be bound by forming a transitive reflexive
59: * closure of types that are referenced by the root types.
60: *
61: * <p>
62: * Errors will be sent to {@link AnnotationProcessorEnvironment#getMessager()}.
63: *
64: * @param rootTypes
65: * The list of types that needs to be bound to XML.
66: * "root references" from JAX-RPC to JAXB is always in the form of (type,annotations) pair.
67: *
68: * @param additionalElementDecls
69: * Add element declarations for the specified element names to
70: * the XML types mapped from the corresponding {@link Reference}s.
71: * Those {@link Reference}s must be included in the <tt>rootTypes</tt> parameter.
72: * In this map, a {@link Reference} can be null, in which case the element name is
73: * declared to have an empty complex type.
74: * (<xs:element name='foo'><xs:complexType/></xs:element>)
75: * This parameter can be null, in which case the method behaves as if the empty map is given.
76: *
77: * @param defaultNamespaceRemap
78: * If not-null, all the uses of the empty default namespace ("") will
79: * be replaced by this namespace URI.
80: *
81: * @param source
82: * The caller supplied view to the annotated source code that JAXB is going to process.
83: *
84: * @return
85: * Non-null if no error was reported. Otherwise null.
86: */
87: J2SJAXBModel bind(Collection<Reference> rootTypes,
88: Map<QName, Reference> additionalElementDecls,
89: String defaultNamespaceRemap,
90: AnnotationProcessorEnvironment source);
91: }
|