aoqi@0: /*
aoqi@0:  * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package javax.xml.bind;
aoqi@0: 
aoqi@0: import javax.xml.transform.Result;
aoqi@0: import java.io.IOException;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Controls where a JAXB implementation puts the generates
aoqi@0:  * schema files.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * An implementation of this abstract class has to be provided by the calling
aoqi@0:  * application to generate schemas.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * This is a class, not an interface so as to allow future versions to evolve
aoqi@0:  * without breaking the compatibility.
aoqi@0:  *
aoqi@0:  * @author
aoqi@0:  *     Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
aoqi@0:  */
aoqi@0: public abstract class SchemaOutputResolver {
aoqi@0:     /**
aoqi@0:      * Decides where the schema file (of the given namespace URI)
aoqi@0:      * will be written, and return it as a {@link Result} object.
aoqi@0:      *
aoqi@0:      * <p>
aoqi@0:      * This method is called only once for any given namespace.
aoqi@0:      * IOW, all the components in one namespace is always written
aoqi@0:      * into the same schema document.
aoqi@0:      *
aoqi@0:      * @param namespaceUri
aoqi@0:      *      The namespace URI that the schema declares.
aoqi@0:      *      Can be the empty string, but never be null.
aoqi@0:      * @param suggestedFileName
aoqi@0:      *      A JAXB implementation generates an unique file name (like "schema1.xsd")
aoqi@0:      *      for the convenience of the callee. This name can be
aoqi@0:      *      used for the file name of the schema, or the callee can just
aoqi@0:      *      ignore this name and come up with its own name.
aoqi@0:      *      This is just a hint.
aoqi@0:      *
aoqi@0:      * @return
aoqi@0:      *      a {@link Result} object that encapsulates the actual destination
aoqi@0:      *      of the schema.
aoqi@0:      *
aoqi@0:      *      If the {@link Result} object has a system ID, it must be an
aoqi@0:      *      absolute system ID. Those system IDs are relativized by the caller and used
aoqi@0:      *      for &lt;xs:import> statements.
aoqi@0:      *
aoqi@0:      *      If the {@link Result} object does not have a system ID, a schema
aoqi@0:      *      for the namespace URI is generated but it won't be explicitly
aoqi@0:      *      &lt;xs:import>ed from other schemas.
aoqi@0:      *
aoqi@0:      *      If {@code null} is returned, the schema generation for this
aoqi@0:      *      namespace URI will be skipped.
aoqi@0:      */
aoqi@0:     public abstract Result createOutput( String namespaceUri, String suggestedFileName ) throws IOException;
aoqi@0: }