Module jakarta.xml.bind

Package jakarta.xml.bind

Class SchemaOutputResolver

java.lang.Object

jakarta.xml.bind.SchemaOutputResolver

public abstract class SchemaOutputResolver
extends Object

Controls where a Jakarta XML Binding implementation puts the generates schema files.

An implementation of this abstract class has to be provided by the calling application to generate schemas.

This is a class, not an interface to allow future versions to evolve without breaking the compatibility.

Author:

Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SchemaOutputResolver()	Do-nothing constructor for the derived classes.

Method Summary

Modifier and Type	Method	Description
abstract Result	createOutput(String namespaceUri, String suggestedFileName)	Decides where the schema file (of the given namespace URI) will be written, and return it as a Result object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SchemaOutputResolver

protected SchemaOutputResolver()

Do-nothing constructor for the derived classes.

Method Details

createOutput

public abstract Result createOutput(String namespaceUri,
 String suggestedFileName)
                             throws IOException

Decides where the schema file (of the given namespace URI) will be written, and return it as a Result object.

This method is called only once for any given namespace. IOW, all the components in one namespace is always written into the same schema document.

Parameters:

namespaceUri - The namespace URI that the schema declares. Can be the empty string, but never be null.

suggestedFileName - A Jakarta XML Binding implementation generates a unique file name (like "schema1.xsd") for the convenience of the callee. This name can be used for the file name of the schema, or the callee can just ignore this name and come up with its own name. This is just a hint.

Returns:

a Result object that encapsulates the actual destination of the schema.

If the Result object has a system ID, it must be an absolute system ID. Those system IDs are relativized by the caller and used for <xs:import> statements.

If the Result object does not have a system ID, a schema for the namespace URI is generated but it won't be explicitly <xs:import>ed from other schemas.

If null is returned, the schema generation for this namespace URI will be skipped.

Throws:

IOException