1 /*
   2  * Copyright (c) 1997, 2017, 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
  23  * questions.
  24  */
  25 
  26 /**
  27  * API for programmatic invocation of XJC and schemagen.
  28  *
  29  * <p>
  30  * This package provides a way to invoke XJC from within another program. The primary target of this API is the JAX-WS
  31  * RI, but we hope that this API would be useful for other integration purposes as well.
  32  *
  33  * <h2>Getting Started: Using XJC</h2>
  34  * <p>
  35  * To invoke XJC, a typical client would do something like this:
  36  * <pre>
  37  *    SchemaCompiler sc = XJC.createSchemaCompiler();
  38  *    sc.parseSchema(new InputSource(schema1Url.toExternalForm()));
  39  *    sc.parseSchema(new InputSource(schema2Url.toExternalForm()));
  40  *    ...
  41  *    S2JModel model = sc.bind();
  42  * </pre>
  43  * <p>
  44  * The bind operation causes XJC to do the bulk of the work, such as figuring out what classes to generate, what
  45  * methods/fields to generate, etc. The obtained model contains useful introspective information about how the binding
  46  * was performed (such as the mapping between XML types and generated Java classes)
  47  *
  48  * <p>
  49  * Once the model is obtained, generate the code into the file system as follows:
  50  * <pre>
  51  *   JCodeModel cm = model.generateCode( null, ... );
  52  *   cm.build(new FileCodeWriter(outputDir));
  53  * </pre>
  54  *
  55  * <h2>Implementation Note</h2>
  56  * <p>
  57  * This package shouldn't contain any implementation code.
  58  */
  59 package com.sun.tools.internal.xjc.api;