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
  23  * questions.
  24  */
  25 
  26 /**
  27  * <h1>Schema to Java compiler</h1>.
  28  *
  29  * <p>
  30  * This module contains the code that implements the schema compiler 'XJC'.
  31  *
  32  * <h2>Overview</h2>
  33  * <p>
  34  * XJC consists of the following major components.
  35  * <dl>
  36  *  <dt>{@link com.sun.tools.internal.xjc.reader Schema reader}
  37  *  <dd>
  38  *   Schema readers read XML Schema documents (or DTD, RELAX NG, ...)
  39  *   and builds a model.
  40  *
  41  *  <dt>{@link com.sun.tools.internal.xjc.model Model}
  42  *  <dd>
  43  *   Model represents the 'blueprint' of the code to be generated.
  44  *   Model talks in terms of higher level constructs like 'class' and 'property'
  45  *   without getting too much into the details of the Java source code.
  46  *
  47  *  <dt>{@link com.sun.tools.internal.xjc.generator Code generator}
  48  *  <dd>
  49  *   Code generators use a model as an input and builds Java code AST
  50  *   into CodeModel. It also produces an {@link com.sun.tools.internal.xjc.outline.Outline} which captures
  51  *   this work.
  52  *
  53  *  <dt>{@link com.sun.tools.internal.xjc.outline.Outline Outline}
  54  *  <dd>
  55  *   Outline can be thought as a series of links between a model
  56  *   and CodeModel.
  57  * </dl>
  58  *
  59  */
  60 package com.sun.tools.internal.xjc;