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:
37: package com.sun.tools.xjc.api;
38:
39: import java.io.IOException;
40:
41: import javax.xml.bind.SchemaOutputResolver;
42: import javax.xml.namespace.QName;
43: import javax.xml.transform.Result;
44:
45: /**
46: * {@link JAXBModel} that exposes additional information available
47: * only for the java->schema direction.
48: *
49: * @author Kohsuke Kawaguchi
50: */
51: public interface J2SJAXBModel extends JAXBModel {
52: /**
53: * Returns the name of the XML Type bound to the
54: * specified Java type.
55: *
56: * @param javaType
57: * must not be null. This must be one of the {@link Reference}s specified
58: * in the {@link JavaCompiler#bind} method.
59: *
60: * @return
61: * null if it is not a part of the input to {@link JavaCompiler#bind}.
62: *
63: * @throws IllegalArgumentException
64: * if the parameter is null
65: */
66: QName getXmlTypeName(Reference javaType);
67:
68: /**
69: * Generates the schema documents from the model.
70: *
71: * @param outputResolver
72: * this object controls the output to which schemas
73: * will be sent.
74: *
75: * @throws IOException
76: * if {@link SchemaOutputResolver} throws an {@link IOException}.
77: */
78: void generateSchema(SchemaOutputResolver outputResolver,
79: ErrorListener errorListener) throws IOException;
80:
81: /**
82: * Generates the episode file from the model.
83: *
84: * <p>
85: * The "episode file" is really just a JAXB customization file (but with vendor extensions,
86: * at this point), that can be used later with a schema compilation to support separate
87: * compilation.
88: *
89: * @param output
90: * This receives the generated episode file.
91: * @since 2.1
92: */
93: void generateEpisodeFile(Result output);
94: }
|