aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.xml.internal.bind.v2.model.core;
aoqi@0: 
aoqi@0: import java.util.Collection;
aoqi@0: 
aoqi@0: import javax.xml.bind.JAXBElement;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * A particular use (specialization) of {@link JAXBElement}.
aoqi@0:  *
aoqi@0:  * TODO: is ElementInfo adaptable?
aoqi@0:  *
aoqi@0:  * @author Kohsuke Kawaguchi
aoqi@0:  */
aoqi@0: public interface ElementInfo<T,C> extends Element<T,C> {
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Gets the object that represents the value property.
aoqi@0:      *
aoqi@0:      * @return
aoqi@0:      *      non-null.
aoqi@0:      */
aoqi@0:     ElementPropertyInfo<T,C> getProperty();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Short for <code>getProperty().ref().get(0)</code>.
aoqi@0:      *
aoqi@0:      * The type of the value this element holds.
aoqi@0:      *
aoqi@0:      * Normally, this is the T of {@code JAXBElement<T>}.
aoqi@0:      * But if the property is adapted, this is the on-the-wire type.
aoqi@0:      *
aoqi@0:      * Or if the element has a list of values, then this field
aoqi@0:      * represents the type of the individual item.
aoqi@0:      *
aoqi@0:      * @see #getContentInMemoryType()
aoqi@0:      */
aoqi@0:     NonElement<T,C> getContentType();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * T of {@code JAXBElement<T>}.
aoqi@0:      *
aoqi@0:      * <p>
aoqi@0:      * This is tied to the in-memory representation.
aoqi@0:      *
aoqi@0:      * @see #getContentType()
aoqi@0:      */
aoqi@0:     T getContentInMemoryType();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Returns the representation for {@link JAXBElement}&lt;<i>contentInMemoryType</i>&gt;.
aoqi@0:      *
aoqi@0:      * <p>
aoqi@0:      * This returns the signature in Java and thus isn't affected by the adapter.
aoqi@0:      */
aoqi@0:     T getType();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * @inheritDoc
aoqi@0:      *
aoqi@0:      * {@link ElementInfo} can only substitute {@link ElementInfo}.
aoqi@0:      */
aoqi@0:     ElementInfo<T,C> getSubstitutionHead();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * All the {@link ElementInfo}s whose {@link #getSubstitutionHead()} points
aoqi@0:      * to this object.
aoqi@0:      *
aoqi@0:      * @return
aoqi@0:      *      can be empty but never null.
aoqi@0:      */
aoqi@0:     Collection<? extends ElementInfo<T,C>> getSubstitutionMembers();
aoqi@0: }