1 /*
2  * Copyright (c) 1997, 2011, 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 /**
29  * {@link NonElement} that represents an {@link Enum} class.
30  *
31  * @author Kohsuke Kawaguchi
32  */
33 public interface EnumLeafInfo<T,C> extends LeafInfo<T,C> {
34     /**
35      * The same as {@link #getType()} but an {@link EnumLeafInfo}
36      * is guaranteed to represent an enum declaration, which is a
37      * kind of a class declaration.
38      *
39      * @return
40      *      always non-null.
41      */
getClazz()42     C getClazz();
43 
44     /**
45      * Returns the base type of the enumeration.
46      *
47      * <p>
48      * For example, with the following enum class, this method
49      * returns {@link BuiltinLeafInfo} for {@link Integer}.
50      *
51      * <pre>
52      * &amp;XmlEnum(Integer.class)
53      * enum Foo {
54      *   &amp;XmlEnumValue("1")
55      *   ONE,
56      *   &amp;XmlEnumValue("2")
57      *   TWO
58      * }
59      * </pre>
60      *
61      * @return
62      *      never null.
63      */
getBaseType()64     NonElement<T,C> getBaseType();
65 
66     /**
67      * Returns the read-only list of enumeration constants.
68      *
69      * @return
70      *      never null. Can be empty (really?).
71      */
getConstants()72     Iterable<? extends EnumConstant> getConstants();
73 }
74