1 /*
   2  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package com.sun.xml.internal.bind.v2.model.core;
  27 
  28 import javax.xml.namespace.QName;
  29 
  30 /**
  31  * {@link TypeInfo} that maps to an element.
  32  *
  33  * Either {@link ElementInfo} or {@link ClassInfo}.
  34  *
  35  * @author Kohsuke Kawaguchi
  36  */
  37 public interface Element<T,C> extends TypeInfo<T,C> {
  38     /**
  39      * Gets the element name of the class.
  40      *
  41      * @return
  42      *      Always non-null.
  43      */
  44     QName getElementName();
  45 
  46     /**
  47      * If this element can substitute another element, return that element.
  48      *
  49      * <p>
  50      * Substitutability of elements are transitive.
  51      *
  52      * @return
  53      *      null if no such element exists.
  54      */
  55     Element<T,C> getSubstitutionHead();
  56 
  57     /**
  58      * If non-null, this element is only active inside the given scope.
  59      */
  60     ClassInfo<T,C> getScope();
  61 }