| com.sun.tools.xjc.api.SchemaCompiler
All known Subclasses: com.sun.tools.xjc.api.impl.s2j.SchemaCompilerImpl,
| SchemaCompiler | | public interface SchemaCompiler (Code) | | Schema-to-Java compiler.
The caller can parse multiple schema documents,
JAXB external binding files (or potentially WSDL
and JSR-109.next mapping files in the future).
All the errors found during this process will be sent
to the registered
ErrorListener .
Once all the documents are parsed, call the
SchemaCompiler.bind() method to get the compiled
JAXBModel object.
Tips: namespace URI -> package customization
The caller can feed the following synthesized schema
to achive the namespace URI -> Java package customization:
<![CDATA[
<schema targetNamespace="xml.namespace.uri"
xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
jaxb:version="1.0">
<annotation><appinfo>
<jaxb:schemaBindings>
<jaxb:package name="java.package.name"/>
</jaxb:schemaBindings>
</appinfo></annotation>
</schema>
]]>
Feed this synthesized schema document for each namespace URI
you need to map.
author:
Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com) |
| Method Summary | |
| S2JJAXBModel | bind()
Obtains the compiled schema object model.
Once this method is called, no other method should be
invoked on the
SchemaCompiler .
null if the compilation fails. | | void | forcePackageName(String packageName)
Forces all the JAXB-generated classes to go into the specific package.
This setting takes precedence over the
SchemaCompiler.setDefaultPackageName(String) or any of the customization found in the JAXB binding files. | | Options | getOptions()
Allows the calling code to tweak more schema compilation details.
The caller can use this method to obtain an
Options instance,
then tweak settings on it. | | ContentHandler | getParserHandler(String systemId)
Parses schemas or external bindings
through SAX events by feeding events into
SAX
ContentHandler . | | void | parseSchema(InputSource source)
Parses a schema or an external binding file
from an external source. | | void | parseSchema(String systemId, Element element)
Parses a schema or an external binding file
from the specified DOM element.
The given DOM element is treated as if it's the root of a
virtual document.
XJC will not be able to print location information for
errors found in this document, since DOM doesn't have them.
For this reason, use of this method is strongly discouraged.
Parameters:
systemId - We need an absolute system ID that uniquely designates the virtualdocument. | | void | parseSchema(String systemId, XMLStreamReader reader)
Parses a schema or an external binding file
from the given source. | | void | resetSchema()
Clears all the schema files parsed so far. | | void | setClassNameAllocator(ClassNameAllocator allocator)
Sets the
ClassNameAllocator to be used for the binding operation. | | void | setDefaultPackageName(String packageName)
Sets the default Java package name into which the generated code will be placed.
Customizations in the binding files/schemas will have precedence over this setting.
Set to null to use the default package name computation algorithm as specified by
the JAXB spec (which is the default behavior.)
Initially this parameter is set to null.
Parameters:
packageName - Java pckage name such as "org.foo.bar". | | void | setEntityResolver(EntityResolver entityResolver)
| | void | setErrorListener(ErrorListener errorListener)
| | void | setTargetVersion(SpecVersion version)
Specifies the target spec version for this compilaion. |
| bind | | S2JJAXBModel bind()(Code) | | Obtains the compiled schema object model.
Once this method is called, no other method should be
invoked on the
SchemaCompiler .
null if the compilation fails. The errors should have beendelivered to the registered error handler in such a case. |
| forcePackageName | | void forcePackageName(String packageName)(Code) | | Forces all the JAXB-generated classes to go into the specific package.
This setting takes precedence over the
SchemaCompiler.setDefaultPackageName(String) or any of the customization found in the JAXB binding files. This method
is designed to implement the semantics of the command-line '-p' option.
This somewhat ugly semantics actually have a long history now and too late
to change.
See Also: SchemaCompiler.setDefaultPackageName(String) |
| getOptions | | Options getOptions()(Code) | | Allows the calling code to tweak more schema compilation details.
The caller can use this method to obtain an
Options instance,
then tweak settings on it. The updated settings will be used when the
SchemaCompiler.bind() method is invoked.
since:
2.0.2Options |
| parseSchema | | void parseSchema(InputSource source)(Code) | | Parses a schema or an external binding file
from an external source.
Parameters:
source - Its system Id must be set to an absolute URI. |
| parseSchema | | void parseSchema(String systemId, Element element)(Code) | | Parses a schema or an external binding file
from the specified DOM element.
The given DOM element is treated as if it's the root of a
virtual document.
XJC will not be able to print location information for
errors found in this document, since DOM doesn't have them.
For this reason, use of this method is strongly discouraged.
Parameters:
systemId - We need an absolute system ID that uniquely designates the virtualdocument. This should be different from the system ID ofthe document which contains this element. One way to do that is by adding a fragment identifierto the system ID of the document. For example, if the documentis "foo.wsdl" and you are passing in its types section, youcan use an unique identifier like "foo.wsdl#types" |
| parseSchema | | void parseSchema(String systemId, XMLStreamReader reader) throws XMLStreamException(Code) | | Parses a schema or an external binding file
from the given source.
A stream reader must be pointing at the element or
at the start of the document.
XML is parsed until the corresponding end tag, then the
sub tree is processed as a schema document.
When this method returns successfully, the parser is at
the next token of the end element.
Parameters:
systemId - The absolute system ID of the document that is being parsed.This information is necessary to avoid double-inclusionand etc.Note that XMLStreamReader.getLocation onlyreturns the system ID of the entity it is parsing, notnecessarily the system ID of the document itself.
throws:
XMLStreamException - If an error happens while parsing a document.Note that not only the parser but also the XJC itselfmay throw this error (as a result of the additional validationfor example.) |
| resetSchema | | void resetSchema()(Code) | | Clears all the schema files parsed so far.
since:
2.1.1 |
| setDefaultPackageName | | void setDefaultPackageName(String packageName)(Code) | | Sets the default Java package name into which the generated code will be placed.
Customizations in the binding files/schemas will have precedence over this setting.
Set to null to use the default package name computation algorithm as specified by
the JAXB spec (which is the default behavior.)
Initially this parameter is set to null.
Parameters:
packageName - Java pckage name such as "org.foo.bar". Use "" to represent the root package,and null to defer to the default computation algorithm.
See Also: SchemaCompiler.forcePackageName(String) |
| setTargetVersion | | void setTargetVersion(SpecVersion version)(Code) | | Specifies the target spec version for this compilaion.
Parameters:
version - If null, XJC will generate the source code thattakes advantage of the latest JAXB spec that it understands.
since:
2.1 EA2 |
|
|