Package com.sun.tools.xjc.api

Interface Mapping

public interface Mapping
JAXB-induced mapping between a Java class and an XML element declaration. A part of the compiler artifacts.

To be precise, this is a mapping between two Java classes and an XML element declaration. There's one Java class/interface that represents the element, and there's another Java class/interface that represents the type of the element. The former is called "element representation" and the latter is called "type representation".

The Mapping interface provides operation that lets the caller convert an instance of the element representation to that of the type representation or vice versa.

Author:
Kohsuke Kawaguchi ([email protected])

  • Method Summary

    Modifier and Type
    Method
    Description
    QName
    getElement()
    Name of the XML element.
    TypeAndAnnotation
    getType()
    Returns the fully-qualified name of the java class for the type of this element.
    List<? extends Property>
    getWrapperStyleDrilldown()
    If this element is a so-called "wrapper-style" element, obtains its member information.

  • Method Details

    • getElement

      QName getElement()
      Name of the XML element.
      Returns:
      never be null.

    • getType

      TypeAndAnnotation getType()
      Returns the fully-qualified name of the java class for the type of this element. TODO: does this method returns the name of the wrapper bean when it's qualified for the wrapper style? Seems no (consider <xs:element name='foo' type='xs:long' />), but then how does JAX-RPC captures that bean?
      Returns:
      never be null.

    • getWrapperStyleDrilldown

      List<? extends Property> getWrapperStyleDrilldown()
      If this element is a so-called "wrapper-style" element, obtains its member information.

      The notion of the wrapper style should be defined by the JAXB spec, and ideally it should differ from that of the JAX-RPC only at the point where the JAX-RPC imposes additional restriction on the element name.

      As of this writing the JAXB spec doesn't define "the wrapper style" and as such the exact definition of what XJC thinks "the wrapper style" isn't spec-ed.

      Ths returned list includes Property defined not just in this class but in all its base classes.

      Returns:
      null if this isn't a wrapper-style element. Otherwise list of Propertys. The order signifies the order they appeared inside a schema.