Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/javax/xml/bind/SchemaOutputResolver.java@9c07ef4934dd (annotated)
src/share/jaxws_classes/javax/xml/bind/SchemaOutputResolver.java
Thu, 31 Aug 2017 15:18:52 +0800
- author
- aoqi
- date
- Thu, 31 Aug 2017 15:18:52 +0800
- changeset 637
- 9c07ef4934dd
- parent 397
- b99d7e355d4b
- parent 0
- 373ffda63c9a
- permissions
- -rw-r--r--
merge
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved. |
| aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| aoqi@0 | 4 | * |
| aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
| aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
| aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
| aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| aoqi@0 | 10 | * |
| aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| aoqi@0 | 15 | * accompanied this code). |
| aoqi@0 | 16 | * |
| aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
| aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| aoqi@0 | 20 | * |
| aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
| aoqi@0 | 23 | * questions. |
| aoqi@0 | 24 | */ |
| aoqi@0 | 25 | |
| aoqi@0 | 26 | package javax.xml.bind; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import javax.xml.transform.Result; |
| aoqi@0 | 29 | import java.io.IOException; |
| aoqi@0 | 30 | |
| aoqi@0 | 31 | /** |
| aoqi@0 | 32 | * Controls where a JAXB implementation puts the generates |
| aoqi@0 | 33 | * schema files. |
| aoqi@0 | 34 | * |
| aoqi@0 | 35 | * <p> |
| aoqi@0 | 36 | * An implementation of this abstract class has to be provided by the calling |
| aoqi@0 | 37 | * application to generate schemas. |
| aoqi@0 | 38 | * |
| aoqi@0 | 39 | * <p> |
| aoqi@0 | 40 | * This is a class, not an interface so as to allow future versions to evolve |
| aoqi@0 | 41 | * without breaking the compatibility. |
| aoqi@0 | 42 | * |
| aoqi@0 | 43 | * @author |
| aoqi@0 | 44 | * Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com) |
| aoqi@0 | 45 | */ |
| aoqi@0 | 46 | public abstract class SchemaOutputResolver { |
| aoqi@0 | 47 | /** |
| aoqi@0 | 48 | * Decides where the schema file (of the given namespace URI) |
| aoqi@0 | 49 | * will be written, and return it as a {@link Result} object. |
| aoqi@0 | 50 | * |
| aoqi@0 | 51 | * <p> |
| aoqi@0 | 52 | * This method is called only once for any given namespace. |
| aoqi@0 | 53 | * IOW, all the components in one namespace is always written |
| aoqi@0 | 54 | * into the same schema document. |
| aoqi@0 | 55 | * |
| aoqi@0 | 56 | * @param namespaceUri |
| aoqi@0 | 57 | * The namespace URI that the schema declares. |
| aoqi@0 | 58 | * Can be the empty string, but never be null. |
| aoqi@0 | 59 | * @param suggestedFileName |
| aoqi@0 | 60 | * A JAXB implementation generates an unique file name (like "schema1.xsd") |
| aoqi@0 | 61 | * for the convenience of the callee. This name can be |
| aoqi@0 | 62 | * used for the file name of the schema, or the callee can just |
| aoqi@0 | 63 | * ignore this name and come up with its own name. |
| aoqi@0 | 64 | * This is just a hint. |
| aoqi@0 | 65 | * |
| aoqi@0 | 66 | * @return |
| aoqi@0 | 67 | * a {@link Result} object that encapsulates the actual destination |
| aoqi@0 | 68 | * of the schema. |
| aoqi@0 | 69 | * |
| aoqi@0 | 70 | * If the {@link Result} object has a system ID, it must be an |
| aoqi@0 | 71 | * absolute system ID. Those system IDs are relativized by the caller and used |
| aoqi@0 | 72 | * for <xs:import> statements. |
| aoqi@0 | 73 | * |
| aoqi@0 | 74 | * If the {@link Result} object does not have a system ID, a schema |
| aoqi@0 | 75 | * for the namespace URI is generated but it won't be explicitly |
| aoqi@0 | 76 | * <xs:import>ed from other schemas. |
| aoqi@0 | 77 | * |
| aoqi@0 | 78 | * If {@code null} is returned, the schema generation for this |
| aoqi@0 | 79 | * namespace URI will be skipped. |
| aoqi@0 | 80 | */ |
| aoqi@0 | 81 | public abstract Result createOutput( String namespaceUri, String suggestedFileName ) throws IOException; |
| aoqi@0 | 82 | } |
