< prev index next >

src/jdk.xml.bind/share/classes/com/sun/tools/internal/xjc/api/SchemaCompiler.java

Print this page


   1 /*
   2  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any


  36 import org.xml.sax.EntityResolver;
  37 import org.xml.sax.InputSource;
  38 
  39 /**
  40  * Schema-to-Java compiler.
  41  *
  42  * <p>
  43  * The caller can parse multiple schema documents,
  44  * JAXB external binding files (or potentially WSDL
  45  * and JSR-109.next mapping files in the future).
  46  *
  47  * <p>
  48  * All the errors found during this process will be sent
  49  * to the registered {@link ErrorListener}.
  50  *
  51  * <p>
  52  * Once all the documents are parsed, call the {@link #bind()}
  53  * method to get the compiled {@link JAXBModel} object.
  54  *
  55  *
  56  * <h2>Tips: namespace URI -> package customization</h2>
  57  * <p>
  58  * The caller can feed the following synthesized schema
  59  * to achive the namespace URI -> Java package customization:
  60  * <pre>{@code
  61  * <schema targetNamespace="xml.namespace.uri"
  62  *   xmlns="http://www.w3.org/2001/XMLSchema"
  63  *   xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
  64  *   jaxb:version="1.0">
  65  *   <annotation><appinfo>
  66  *     <jaxb:schemaBindings>
  67  *       <jaxb:package name="java.package.name"/>
  68  *     </jaxb:schemaBindings>
  69  *   </appinfo></annotation>
  70  * </schema>
  71  * }</pre>
  72  * Feed this synthesized schema document for each namespace URI
  73  * you need to map.
  74  *
  75  * @author
  76  *     Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
  77  */
  78 public interface SchemaCompiler {
  79     /**


   1 /*
   2  * Copyright (c) 1997, 2015, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any


  36 import org.xml.sax.EntityResolver;
  37 import org.xml.sax.InputSource;
  38 
  39 /**
  40  * Schema-to-Java compiler.
  41  *
  42  * <p>
  43  * The caller can parse multiple schema documents,
  44  * JAXB external binding files (or potentially WSDL
  45  * and JSR-109.next mapping files in the future).
  46  *
  47  * <p>
  48  * All the errors found during this process will be sent
  49  * to the registered {@link ErrorListener}.
  50  *
  51  * <p>
  52  * Once all the documents are parsed, call the {@link #bind()}
  53  * method to get the compiled {@link JAXBModel} object.
  54  *
  55  *
  56  * <h2>Tips: namespace URI {@code -> } package customization</h2>
  57  * <p>
  58  * The caller can feed the following synthesized schema
  59  * to achive the namespace URI {@code -> } Java package customization:
  60  * <pre>{@code
  61  * <schema targetNamespace="xml.namespace.uri"
  62  *   xmlns="http://www.w3.org/2001/XMLSchema"
  63  *   xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
  64  *   jaxb:version="1.0">
  65  *   <annotation><appinfo>
  66  *     <jaxb:schemaBindings>
  67  *       <jaxb:package name="java.package.name"/>
  68  *     </jaxb:schemaBindings>
  69  *   </appinfo></annotation>
  70  * </schema>
  71  * }</pre>
  72  * Feed this synthesized schema document for each namespace URI
  73  * you need to map.
  74  *
  75  * @author
  76  *     Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
  77  */
  78 public interface SchemaCompiler {
  79     /**


< prev index next >