001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036: package com.sun.tools.xjc.api;
037:
038: import java.util.List;
039:
040: import javax.xml.namespace.QName;
041:
042: /**
043: * JAXB-induced mapping between a Java class
044: * and an XML element declaration. A part of the compiler artifacts.
045: *
046: * <p>
047: * To be precise, this is a mapping between two Java classes and an
048: * XML element declaration. There's one Java class/interface that
049: * represents the element, and there's another Java class/interface that
050: * represents the type of the element.
051: *
052: * The former is called "element representation" and the latter is called
053: * "type representation".
054: *
055: * <p>
056: * The {@link Mapping} interface provides operation that lets the caller
057: * convert an instance of the element representation to that of the
058: * type representation or vice versa.
059: *
060: * @author
061: * Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
062: */
063: public interface Mapping {
064: /**
065: * Name of the XML element.
066: *
067: * @return
068: * never be null.
069: */
070: QName getElement();
071:
072: /**
073: * Returns the fully-qualified name of the java class for the type of this element.
074: *
075: * TODO: does this method returns the name of the wrapper bean when it's qualified
076: * for the wrapper style? Seems no (consider <xs:element name='foo' type='xs:long' />),
077: * but then how does JAX-RPC captures that bean?
078: *
079: * @return
080: * never be null.
081: */
082: TypeAndAnnotation getType();
083:
084: /**
085: * If this element is a so-called "wrapper-style" element,
086: * obtains its member information.
087: *
088: * <p>
089: * The notion of the wrapper style should be defined by the JAXB spec,
090: * and ideally it should differ from that of the JAX-RPC only at
091: * the point where the JAX-RPC imposes additional restriction
092: * on the element name.
093: *
094: * <p>
095: * As of this writing the JAXB spec doesn't define "the wrapper style"
096: * and as such the exact definition of what XJC thinks
097: * "the wrapper style" isn't spec-ed.
098: *
099: * <p>
100: * Ths returned list includes {@link Property} defined not just
101: * in this class but in all its base classes.
102: *
103: * @return
104: * null if this isn't a wrapper-style element.
105: * Otherwise list of {@link Property}s. The order signifies
106: * the order they appeared inside a schema.
107: */
108: List<? extends Property> getWrapperStyleDrilldown();
109: }
|