Package com.sun.tools.xjc.api

package com.sun.tools.xjc.api
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.

  • Class
    Description
    ClassNameAllocator
    Callback interface that allows the driver of the XJC API to rename JAXB-generated classes/interfaces/enums.
    ErrorListener
    Implemented by the driver of the compiler engine to handle errors found during the compiliation.
    J2SJAXBModel
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use com.sun.tools.jxc.api.J2SJAXBModel instead.
    JavaCompiler
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use com.sun.tools.jxc.api.JavaCompiler instead.
    JAXBModel
    The in-memory representation of the JAXB binding.
    Mapping
    JAXB-induced mapping between a Java class and an XML element declaration.
    Property
    Represents a property of a wrapper-style element.
    Reference
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use com.sun.tools.jxc.api.Reference instead.
    S2JJAXBModel
    JAXBModel that exposes additional information available only for the schema -> java direction.
    SchemaCompiler
    Schema-to-Java compiler.
    SpecVersion
    Represents the spec version constant.
    TypeAndAnnotation
    Java type and associated JAXB annotations.
    XJC
    Entry point to the programatic API to access schema compiler (XJC) and schema generator (schemagen).