~ubuntu-branches/ubuntu/vivid/jaxb/vivid-proposed

« back to all changes in this revision

Viewing changes to runtime/src/com/sun/xml/bind/v2/model/core/MaybeElement.java

  • Committer: Package Import Robot
  • Author(s): Timo Aaltonen
  • Date: 2014-09-01 14:26:44 UTC
  • Revision ID: package-import@ubuntu.com-20140901142644-nox3y6t2unq2wxjf
Tags: upstream-2.2.5
ImportĀ upstreamĀ versionĀ 2.2.5

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/*
 
2
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 
3
 *
 
4
 * Copyright (c) 1997-2011 Oracle and/or its affiliates. All rights reserved.
 
5
 *
 
6
 * The contents of this file are subject to the terms of either the GNU
 
7
 * General Public License Version 2 only ("GPL") or the Common Development
 
8
 * and Distribution License("CDDL") (collectively, the "License").  You
 
9
 * may not use this file except in compliance with the License.  You can
 
10
 * obtain a copy of the License at
 
11
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 
12
 * or packager/legal/LICENSE.txt.  See the License for the specific
 
13
 * language governing permissions and limitations under the License.
 
14
 *
 
15
 * When distributing the software, include this License Header Notice in each
 
16
 * file and include the License file at packager/legal/LICENSE.txt.
 
17
 *
 
18
 * GPL Classpath Exception:
 
19
 * Oracle designates this particular file as subject to the "Classpath"
 
20
 * exception as provided by Oracle in the GPL Version 2 section of the License
 
21
 * file that accompanied this code.
 
22
 *
 
23
 * Modifications:
 
24
 * If applicable, add the following below the License Header, with the fields
 
25
 * enclosed by brackets [] replaced by your own identifying information:
 
26
 * "Portions Copyright [year] [name of copyright owner]"
 
27
 *
 
28
 * Contributor(s):
 
29
 * If you wish your version of this file to be governed by only the CDDL or
 
30
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 
31
 * elects to include this software in this distribution under the [CDDL or GPL
 
32
 * Version 2] license."  If you don't indicate a single choice of license, a
 
33
 * recipient has the option to distribute your version of this file under
 
34
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 
35
 * its licensees as provided above.  However, if you add GPL Version 2 code
 
36
 * and therefore, elected the GPL Version 2 license, then the option applies
 
37
 * only if the new code is made subject to such option by the copyright
 
38
 * holder.
 
39
 */
 
40
 
 
41
package com.sun.xml.bind.v2.model.core;
 
42
 
 
43
import javax.xml.namespace.QName;
 
44
 
 
45
/**
 
46
 * Some {@link NonElement} can optionally be an {@link Element}.
 
47
 *
 
48
 * This interface captures such characteristics.
 
49
 *
 
50
 * @author Kohsuke Kawaguchi
 
51
 */
 
52
public interface MaybeElement<T,C> extends NonElement<T,C> {
 
53
    /**
 
54
     * If the class is bound to an element, return true.
 
55
     *
 
56
     * <p>
 
57
     * Note that when this is true, the class is bound to both an element
 
58
     * and a type.
 
59
     */
 
60
    boolean isElement();
 
61
 
 
62
    /**
 
63
     * Gets the element name of the class, if the class is bound
 
64
     * to an element.
 
65
     *
 
66
     * @return
 
67
     *      non-null iff {@link #isElement()}.
 
68
     */
 
69
    QName getElementName();
 
70
 
 
71
    /**
 
72
     * Returns the {@link Element} aspect of this {@link ClassInfo}.
 
73
     *
 
74
     * @return
 
75
     *      null if {@link #isElement()}==false, non-null if {@link #isElement()}==true.
 
76
     */
 
77
    Element<T,C> asElement();
 
78
}