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: /**
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: */
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: * &XmlEnum(Integer.class)
53: * enum Foo {
54: * &XmlEnumValue("1")
55: * ONE,
56: * &XmlEnumValue("2")
57: * TWO
58: * }
59: * </pre>
60: *
61: * @return
62: * never null.
63: */
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: */
72: Iterable<? extends EnumConstant> getConstants();
73: }
|