All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.sun.tools.xjc.api.Mapping Maven / Gradle / Ivy

There is a newer version: 4.0.5
Show newest version
/*
 * Copyright (c) 1997, 2021 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
 */

package com.sun.tools.xjc.api;

import java.util.List;

import javax.xml.namespace.QName;

/**
 * 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 {@link 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]) */ public interface Mapping { /** * Name of the XML element. * * @return * never be null. */ QName getElement(); /** * 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 {@code }), * but then how does JAX-RPC captures that bean? * * @return * never be null. */ TypeAndAnnotation getType(); /** * 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 {@link Property} defined not just * in this class but in all its base classes. * * @return * null if this isn't a wrapper-style element. * Otherwise list of {@link Property}s. The order signifies * the order they appeared inside a schema. */ List getWrapperStyleDrilldown(); }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy