com.sun.tools.xjc.api.SchemaCompiler Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.tools.xjc.api;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamReader;
import com.sun.istack.NotNull;
import com.sun.tools.xjc.Options;
import org.w3c.dom.Element;
import org.xml.sax.ContentHandler;
import org.xml.sax.EntityResolver;
import org.xml.sax.InputSource;
/**
* 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 {@link ErrorListener}.
*
*
* Once all the documents are parsed, call the {@link #bind()}
* method to get the compiled {@link JAXBModel} object.
*
*
*
Tips: namespace URI -> package customization
*
* The caller can feed the following synthesized schema
* to achive the namespace URI -> Java package customization:
*
* <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 ([email protected])
*/
public interface SchemaCompiler {
/**
* Parses schemas or external bindings
* through SAX events by feeding events into
* SAX {@link ContentHandler}.
*
* @param systemId
* The system ID of the document to be read in.
*
* @see #parseSchema(String, XMLStreamReader)
*/
ContentHandler getParserHandler( String systemId );
/**
* Parses a schema or an external binding file
* from an external source.
*
* @param source
* Its system Id must be set to an absolute URI.
*/
void parseSchema( InputSource source );
/**
* Specifies the target spec version for this compilaion.
*
* @param version
* If null, XJC will generate the source code that
* takes advantage of the latest JAXB spec that it understands.
* @since 2.1 EA2
*/
void setTargetVersion( SpecVersion version );
/**
* 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.
*
* @param systemId
* We need an absolute system ID that uniquely designates the virtual
* document. This should be different from the system ID of
* the document which contains this element.
*
* One way to do that is by adding a fragment identifier
* to the system ID of the document. For example, if the document
* is "foo.wsdl" and you are passing in its types section, you
* can use an unique identifier like "foo.wsdl#types"
*/
void parseSchema( String systemId, Element element );
/**
* 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.
*
* @param systemId
* The absolute system ID of the document that is being parsed.
* This information is necessary to avoid double-inclusion
* and etc.
*
* Note that {@link XMLStreamReader#getLocation()} only
* returns the system ID of the entity it is parsing, not
* necessarily 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 itself
* may throw this error (as a result of the additional validation
* for example.)
*/
void parseSchema( String systemId, XMLStreamReader reader ) throws XMLStreamException;
void setErrorListener( ErrorListener errorListener );
void setEntityResolver( EntityResolver entityResolver );
/**
* 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.
*
* @param 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 #forcePackageName(String)
*/
void setDefaultPackageName( String packageName );
/**
* Forces all the JAXB-generated classes to go into the specific package.
*
*
* This setting takes precedence over the {@link #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 #setDefaultPackageName(String)
*/
void forcePackageName( String packageName );
/**
* Sets the {@link ClassNameAllocator} to be used for the binding operation.
*
*
* This mechanism would allow the caller to participate in the binding operation.
*
* @see ClassNameAllocator
*/
void setClassNameAllocator( ClassNameAllocator allocator );
/**
* Clears all the schema files parsed so far.
*
* @since 2.1.1
*/
void resetSchema();
/**
* Obtains the compiled schema object model.
*
* Once this method is called, no other method should be
* invoked on the {@link SchemaCompiler}.
*
* @return
* null if the compilation fails. The errors should have been
* delivered to the registered error handler in such a case.
*/
S2JJAXBModel bind();
/**
* Allows the calling code to tweak more schema compilation details.
*
*
* The caller can use this method to obtain an {@link Options} instance,
* then tweak settings on it. The updated settings will be used when the
* {@link #bind()} method is invoked.
*
*
* The returned {@link Options} object is useful for example to specify
* command-line arguments.
*
* @since 2.0.2
* @deprecated
* This method is not really "deprecated" (in the sense of being removed
* from future versions), but the JAXB team is not committed to evolve
* {@link Options} class in the compatible fashion. So please don't
* use this method unless you know what you're doing.
*/
@NotNull Options getOptions();
}