01: /*
02: * Copyright 2006 Sun Microsystems, Inc. All Rights Reserved.
03: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04: *
05: * This code is free software; you can redistribute it and/or modify it
06: * under the terms of the GNU General Public License version 2 only, as
07: * published by the Free Software Foundation. Sun designates this
08: * particular file as subject to the "Classpath" exception as provided
09: * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22: * CA 95054 USA or visit www.sun.com if you need additional information or
23: * have any questions.
24: */
25:
26: package com.sun.xml.internal.bind.v2.model.core;
27:
28: import javax.xml.namespace.QName;
29:
30: /**
31: * Some {@link NonElement} can optionally be an {@link Element}.
32: *
33: * This interface captures such characteristics.
34: *
35: * @author Kohsuke Kawaguchi
36: */
37: public interface MaybeElement<T, C> extends NonElement<T, C> {
38: /**
39: * If the class is bound to an element, return true.
40: *
41: * <p>
42: * Note that when this is true, the class is bound to both an element
43: * and a type.
44: */
45: boolean isElement();
46:
47: /**
48: * Gets the element name of the class, if the class is bound
49: * to an element.
50: *
51: * @return
52: * non-null iff {@link #isElement()}.
53: */
54: QName getElementName();
55:
56: /**
57: * Returns the {@link Element} aspect of this {@link ClassInfo}.
58: *
59: * @return
60: * null if {@link #isElement()}==false, non-null if {@link #isElement()}==true.
61: */
62: Element<T, C> asElement();
63: }
|