Mercurial > jdk8-mips64-public > jaxws / file comparison
comparison: src/share/jaxws_classes/javax/xml/bind/SchemaOutputResolver.java
src/share/jaxws_classes/javax/xml/bind/SchemaOutputResolver.java
- changeset 0
- 373ffda63c9a
- child 637
- 9c07ef4934dd
equal
deleted
inserted
replaced
| -1:000000000000 | 0:373ffda63c9a |
|---|---|
| 1 /* | |
| 2 * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved. | |
| 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. | |
| 4 * | |
| 5 * This code is free software; you can redistribute it and/or modify it | |
| 6 * under the terms of the GNU General Public License version 2 only, as | |
| 7 * published by the Free Software Foundation. Oracle designates this | |
| 8 * particular file as subject to the "Classpath" exception as provided | |
| 9 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA | |
| 22 * or visit www.oracle.com if you need additional information or have any | |
| 23 * questions. | |
| 24 */ | |
| 25 | |
| 26 package javax.xml.bind; | |
| 27 | |
| 28 import javax.xml.transform.Result; | |
| 29 import java.io.IOException; | |
| 30 | |
| 31 /** | |
| 32 * Controls where a JAXB implementation puts the generates | |
| 33 * schema files. | |
| 34 * | |
| 35 * <p> | |
| 36 * An implementation of this abstract class has to be provided by the calling | |
| 37 * application to generate schemas. | |
| 38 * | |
| 39 * <p> | |
| 40 * This is a class, not an interface so as to allow future versions to evolve | |
| 41 * without breaking the compatibility. | |
| 42 * | |
| 43 * @author | |
| 44 * Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com) | |
| 45 */ | |
| 46 public abstract class SchemaOutputResolver { | |
| 47 /** | |
| 48 * Decides where the schema file (of the given namespace URI) | |
| 49 * will be written, and return it as a {@link Result} object. | |
| 50 * | |
| 51 * <p> | |
| 52 * This method is called only once for any given namespace. | |
| 53 * IOW, all the components in one namespace is always written | |
| 54 * into the same schema document. | |
| 55 * | |
| 56 * @param namespaceUri | |
| 57 * The namespace URI that the schema declares. | |
| 58 * Can be the empty string, but never be null. | |
| 59 * @param suggestedFileName | |
| 60 * A JAXB implementation generates an unique file name (like "schema1.xsd") | |
| 61 * for the convenience of the callee. This name can be | |
| 62 * used for the file name of the schema, or the callee can just | |
| 63 * ignore this name and come up with its own name. | |
| 64 * This is just a hint. | |
| 65 * | |
| 66 * @return | |
| 67 * a {@link Result} object that encapsulates the actual destination | |
| 68 * of the schema. | |
| 69 * | |
| 70 * If the {@link Result} object has a system ID, it must be an | |
| 71 * absolute system ID. Those system IDs are relativized by the caller and used | |
| 72 * for <xs:import> statements. | |
| 73 * | |
| 74 * If the {@link Result} object does not have a system ID, a schema | |
| 75 * for the namespace URI is generated but it won't be explicitly | |
| 76 * <xs:import>ed from other schemas. | |
| 77 * | |
| 78 * If {@code null} is returned, the schema generation for this | |
| 79 * namespace URI will be skipped. | |
| 80 */ | |
| 81 public abstract Result createOutput( String namespaceUri, String suggestedFileName ) throws IOException; | |
| 82 } |
