com.sun.tools.xjc.api.package-info Maven / Gradle / Ivy
/*
* Copyright (c) 2017, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
/**
* API for programmatic invocation of XJC and schemagen.
*
*
* This package provides a way to invoke XJC from within another program. The primary target of this API is the JAX-WS
* RI, but we hope that this API would be useful for other integration purposes as well.
*
*
Getting Started: Using XJC
*
* To invoke XJC, a typical client would do something like this:
*
* SchemaCompiler sc = XJC.createSchemaCompiler();
* sc.parseSchema(new InputSource(schema1Url.toExternalForm()));
* sc.parseSchema(new InputSource(schema2Url.toExternalForm()));
* ...
* S2JModel model = sc.bind();
*
*
* The bind operation causes XJC to do the bulk of the work, such as figuring out what classes to generate, what
* methods/fields to generate, etc. The obtained model contains useful introspective information about how the binding
* was performed (such as the mapping between XML types and generated Java classes)
*
*
* Once the model is obtained, generate the code into the file system as follows:
*
* JCodeModel cm = model.generateCode( null, ... );
* cm.build(new FileCodeWriter(outputDir));
*
*
* Implementation Note
*
* This package shouldn't contain any implementation code.
*/
package com.sun.tools.xjc.api;