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:
037: package com.sun.xml.bind.v2.model.core;
038:
039: import java.util.Collection;
040:
041: import javax.xml.bind.JAXBElement;
042:
043: /**
044: * A particular use (specialization) of {@link JAXBElement}.
045: *
046: * TODO: is ElementInfo adaptable?
047: *
048: * @author Kohsuke Kawaguchi
049: */
050: public interface ElementInfo<T, C> extends Element<T, C> {
051:
052: /**
053: * Gets the object that represents the value property.
054: *
055: * @return
056: * non-null.
057: */
058: ElementPropertyInfo<T, C> getProperty();
059:
060: /**
061: * Short for <code>getProperty().ref().get(0)</code>.
062: *
063: * The type of the value this element holds.
064: *
065: * Normally, this is the T of {@code JAXBElement<T>}.
066: * But if the property is adapted, this is the on-the-wire type.
067: *
068: * Or if the element has a list of values, then this field
069: * represents the type of the individual item.
070: *
071: * @see #getContentInMemoryType()
072: */
073: NonElement<T, C> getContentType();
074:
075: /**
076: * T of {@code JAXBElement<T>}.
077: *
078: * <p>
079: * This is tied to the in-memory representation.
080: *
081: * @see #getContentType()
082: */
083: T getContentInMemoryType();
084:
085: /**
086: * Returns the representation for {@link JAXBElement}<<i>contentInMemoryType</i>>.
087: *
088: * <p>
089: * This returns the signature in Java and thus isn't affected by the adapter.
090: */
091: T getType();
092:
093: /**
094: * @inheritDoc
095: *
096: * {@link ElementInfo} can only substitute {@link ElementInfo}.
097: */
098: ElementInfo<T, C> getSubstitutionHead();
099:
100: /**
101: * All the {@link ElementInfo}s whose {@link #getSubstitutionHead()} points
102: * to this object.
103: *
104: * @return
105: * can be empty but never null.
106: */
107: Collection<? extends ElementInfo<T, C>> getSubstitutionMembers();
108: }
|