1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/share/jaxws_classes/javax/xml/bind/SchemaOutputResolver.java Tue Mar 06 16:09:35 2012 -0800
1.3 @@ -0,0 +1,82 @@
1.4 +/*
1.5 + * Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved.
1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.7 + *
1.8 + * This code is free software; you can redistribute it and/or modify it
1.9 + * under the terms of the GNU General Public License version 2 only, as
1.10 + * published by the Free Software Foundation. Oracle designates this
1.11 + * particular file as subject to the "Classpath" exception as provided
1.12 + * by Oracle in the LICENSE file that accompanied this code.
1.13 + *
1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.17 + * version 2 for more details (a copy is included in the LICENSE file that
1.18 + * accompanied this code).
1.19 + *
1.20 + * You should have received a copy of the GNU General Public License version
1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.23 + *
1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1.25 + * or visit www.oracle.com if you need additional information or have any
1.26 + * questions.
1.27 + */
1.28 +
1.29 +package javax.xml.bind;
1.30 +
1.31 +import javax.xml.transform.Result;
1.32 +import java.io.IOException;
1.33 +
1.34 +/**
1.35 + * Controls where a JAXB implementation puts the generates
1.36 + * schema files.
1.37 + *
1.38 + * <p>
1.39 + * An implementation of this abstract class has to be provided by the calling
1.40 + * application to generate schemas.
1.41 + *
1.42 + * <p>
1.43 + * This is a class, not an interface so as to allow future versions to evolve
1.44 + * without breaking the compatibility.
1.45 + *
1.46 + * @author
1.47 + * Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
1.48 + */
1.49 +public abstract class SchemaOutputResolver {
1.50 + /**
1.51 + * Decides where the schema file (of the given namespace URI)
1.52 + * will be written, and return it as a {@link Result} object.
1.53 + *
1.54 + * <p>
1.55 + * This method is called only once for any given namespace.
1.56 + * IOW, all the components in one namespace is always written
1.57 + * into the same schema document.
1.58 + *
1.59 + * @param namespaceUri
1.60 + * The namespace URI that the schema declares.
1.61 + * Can be the empty string, but never be null.
1.62 + * @param suggestedFileName
1.63 + * A JAXB implementation generates an unique file name (like "schema1.xsd")
1.64 + * for the convenience of the callee. This name can be
1.65 + * used for the file name of the schema, or the callee can just
1.66 + * ignore this name and come up with its own name.
1.67 + * This is just a hint.
1.68 + *
1.69 + * @return
1.70 + * a {@link Result} object that encapsulates the actual destination
1.71 + * of the schema.
1.72 + *
1.73 + * If the {@link Result} object has a system ID, it must be an
1.74 + * absolute system ID. Those system IDs are relativized by the caller and used
1.75 + * for <xs:import> statements.
1.76 + *
1.77 + * If the {@link Result} object does not have a system ID, a schema
1.78 + * for the namespace URI is generated but it won't be explicitly
1.79 + * <xs:import>ed from other schemas.
1.80 + *
1.81 + * If {@code null} is returned, the schema generation for this
1.82 + * namespace URI will be skipped.
1.83 + */
1.84 + public abstract Result createOutput( String namespaceUri, String suggestedFileName ) throws IOException;
1.85 +}
