jaxws/src/jdk.xml.bind/share/classes/com/sun/tools/internal/xjc/api/package-info.java
author aefimov
Thu, 16 Feb 2017 13:14:39 +0300
changeset 43852 93a527059d8a
permissions -rw-r--r--
8174735: Update JAX-WS RI integration to latest version Reviewed-by: alanb, mchung, lancea Contributed-by: roman.grigoriadi@oracle.com
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
43852
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
     1
/*
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
     2
 * Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
     4
 *
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    10
 *
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    15
 * accompanied this code).
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    16
 *
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    20
 *
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    23
 * questions.
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    24
 */
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    25
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    26
/**
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    27
 * API for programmatic invocation of XJC and schemagen.
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    28
 *
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    29
 * <p>
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    30
 * This package provides a way to invoke XJC from within another program. The primary target of this API is the JAX-WS
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    31
 * RI, but we hope that this API would be useful for other integration purposes as well.
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    32
 *
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    33
 * <h2>Getting Started: Using XJC</h2>
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    34
 * <p>
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    35
 * To invoke XJC, a typical client would do something like this:
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    36
 * <pre>
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    37
 *    SchemaCompiler sc = XJC.createSchemaCompiler();
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    38
 *    sc.parseSchema(new InputSource(schema1Url.toExternalForm()));
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    39
 *    sc.parseSchema(new InputSource(schema2Url.toExternalForm()));
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    40
 *    ...
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    41
 *    S2JModel model = sc.bind();
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    42
 * </pre>
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    43
 * <p>
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    44
 * The bind operation causes XJC to do the bulk of the work, such as figuring out what classes to generate, what
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    45
 * methods/fields to generate, etc. The obtained model contains useful introspective information about how the binding
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    46
 * was performed (such as the mapping between XML types and generated Java classes)
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    47
 *
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    48
 * <p>
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    49
 * Once the model is obtained, generate the code into the file system as follows:
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    50
 * <pre>
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    51
 *   JCodeModel cm = model.generateCode( null, ... );
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    52
 *   cm.build(new FileCodeWriter(outputDir));
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    53
 * </pre>
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    54
 *
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    55
 * <h2>Implementation Note</h2>
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    56
 * <p>
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    57
 * This package shouldn't contain any implementation code.
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    58
 */
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents:
diff changeset
    59
package com.sun.tools.internal.xjc.api;