Thu, 31 Aug 2017 15:18:52 +0800
merge
aoqi@0 | 1 | /* |
aoqi@0 | 2 | * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved. |
aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
aoqi@0 | 4 | * |
aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
aoqi@0 | 10 | * |
aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
aoqi@0 | 15 | * accompanied this code). |
aoqi@0 | 16 | * |
aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
aoqi@0 | 20 | * |
aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
aoqi@0 | 23 | * questions. |
aoqi@0 | 24 | */ |
aoqi@0 | 25 | |
aoqi@0 | 26 | package com.sun.xml.internal.bind.v2.model.core; |
aoqi@0 | 27 | |
aoqi@0 | 28 | import java.util.Collection; |
aoqi@0 | 29 | |
aoqi@0 | 30 | import javax.xml.bind.JAXBElement; |
aoqi@0 | 31 | |
aoqi@0 | 32 | /** |
aoqi@0 | 33 | * A particular use (specialization) of {@link JAXBElement}. |
aoqi@0 | 34 | * |
aoqi@0 | 35 | * TODO: is ElementInfo adaptable? |
aoqi@0 | 36 | * |
aoqi@0 | 37 | * @author Kohsuke Kawaguchi |
aoqi@0 | 38 | */ |
aoqi@0 | 39 | public interface ElementInfo<T,C> extends Element<T,C> { |
aoqi@0 | 40 | |
aoqi@0 | 41 | /** |
aoqi@0 | 42 | * Gets the object that represents the value property. |
aoqi@0 | 43 | * |
aoqi@0 | 44 | * @return |
aoqi@0 | 45 | * non-null. |
aoqi@0 | 46 | */ |
aoqi@0 | 47 | ElementPropertyInfo<T,C> getProperty(); |
aoqi@0 | 48 | |
aoqi@0 | 49 | /** |
aoqi@0 | 50 | * Short for <code>getProperty().ref().get(0)</code>. |
aoqi@0 | 51 | * |
aoqi@0 | 52 | * The type of the value this element holds. |
aoqi@0 | 53 | * |
aoqi@0 | 54 | * Normally, this is the T of {@code JAXBElement<T>}. |
aoqi@0 | 55 | * But if the property is adapted, this is the on-the-wire type. |
aoqi@0 | 56 | * |
aoqi@0 | 57 | * Or if the element has a list of values, then this field |
aoqi@0 | 58 | * represents the type of the individual item. |
aoqi@0 | 59 | * |
aoqi@0 | 60 | * @see #getContentInMemoryType() |
aoqi@0 | 61 | */ |
aoqi@0 | 62 | NonElement<T,C> getContentType(); |
aoqi@0 | 63 | |
aoqi@0 | 64 | /** |
aoqi@0 | 65 | * T of {@code JAXBElement<T>}. |
aoqi@0 | 66 | * |
aoqi@0 | 67 | * <p> |
aoqi@0 | 68 | * This is tied to the in-memory representation. |
aoqi@0 | 69 | * |
aoqi@0 | 70 | * @see #getContentType() |
aoqi@0 | 71 | */ |
aoqi@0 | 72 | T getContentInMemoryType(); |
aoqi@0 | 73 | |
aoqi@0 | 74 | /** |
aoqi@0 | 75 | * Returns the representation for {@link JAXBElement}<<i>contentInMemoryType</i>>. |
aoqi@0 | 76 | * |
aoqi@0 | 77 | * <p> |
aoqi@0 | 78 | * This returns the signature in Java and thus isn't affected by the adapter. |
aoqi@0 | 79 | */ |
aoqi@0 | 80 | T getType(); |
aoqi@0 | 81 | |
aoqi@0 | 82 | /** |
aoqi@0 | 83 | * @inheritDoc |
aoqi@0 | 84 | * |
aoqi@0 | 85 | * {@link ElementInfo} can only substitute {@link ElementInfo}. |
aoqi@0 | 86 | */ |
aoqi@0 | 87 | ElementInfo<T,C> getSubstitutionHead(); |
aoqi@0 | 88 | |
aoqi@0 | 89 | /** |
aoqi@0 | 90 | * All the {@link ElementInfo}s whose {@link #getSubstitutionHead()} points |
aoqi@0 | 91 | * to this object. |
aoqi@0 | 92 | * |
aoqi@0 | 93 | * @return |
aoqi@0 | 94 | * can be empty but never null. |
aoqi@0 | 95 | */ |
aoqi@0 | 96 | Collection<? extends ElementInfo<T,C>> getSubstitutionMembers(); |
aoqi@0 | 97 | } |