01: /*
02: * Copyright 2006 Sun Microsystems, Inc. All Rights Reserved.
03: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04: *
05: * This code is free software; you can redistribute it and/or modify it
06: * under the terms of the GNU General Public License version 2 only, as
07: * published by the Free Software Foundation. Sun designates this
08: * particular file as subject to the "Classpath" exception as provided
09: * by Sun in the LICENSE file that accompanied this code.
10: *
11: * This code is distributed in the hope that it will be useful, but WITHOUT
12: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14: * version 2 for more details (a copy is included in the LICENSE file that
15: * accompanied this code).
16: *
17: * You should have received a copy of the GNU General Public License version
18: * 2 along with this work; if not, write to the Free Software Foundation,
19: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20: *
21: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22: * CA 95054 USA or visit www.sun.com if you need additional information or
23: * have any questions.
24: */
25:
26: package com.sun.tools.internal.xjc.api;
27:
28: import java.util.Collection;
29: import java.util.Map;
30:
31: import javax.xml.namespace.QName;
32:
33: import com.sun.mirror.apt.AnnotationProcessorEnvironment;
34:
35: /**
36: * Java-to-Schema compiler.
37: *
38: * @author
39: * Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
40: */
41: public interface JavaCompiler {
42:
43: /**
44: * Compiles the given annotated Java source code.
45: *
46: * <p>
47: * This operation takes a set of "root types", then compute the list of
48: * all the types that need to be bound by forming a transitive reflexive
49: * closure of types that are referenced by the root types.
50: *
51: * <p>
52: * Errors will be sent to {@link AnnotationProcessorEnvironment#getMessager()}.
53: *
54: * @param rootTypes
55: * The list of types that needs to be bound to XML.
56: * "root references" from JAX-RPC to JAXB is always in the form of (type,annotations) pair.
57: *
58: * @param additionalElementDecls
59: * Add element declarations for the specified element names to
60: * the XML types mapped from the corresponding {@link Reference}s.
61: * Those {@link Reference}s must be included in the <tt>rootTypes</tt> parameter.
62: * In this map, a {@link Reference} can be null, in which case the element name is
63: * declared to have an empty complex type.
64: * (<xs:element name='foo'><xs:complexType/></xs:element>)
65: * This parameter can be null, in which case the method behaves as if the empty map is given.
66: *
67: * @param defaultNamespaceRemap
68: * If not-null, all the uses of the empty default namespace ("") will
69: * be replaced by this namespace URI.
70: *
71: * @param source
72: * The caller supplied view to the annotated source code that JAXB is going to process.
73: *
74: * @return
75: * Non-null if no error was reported. Otherwise null.
76: */
77: J2SJAXBModel bind(Collection<Reference> rootTypes,
78: Map<QName, Reference> additionalElementDecls,
79: String defaultNamespaceRemap,
80: AnnotationProcessorEnvironment source);
81: }
|