/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package com.sun.xml.internal.bind.v2.model.core;

/**

 * {@link NonElement} that represents an {@link Enum} class.

 *

 * @author Kohsuke Kawaguchi

 */

public interface EnumLeafInfo<T,C> extends LeafInfo<T,C> {

    /**

     * The same as {@link #getType()} but an {@link EnumLeafInfo}

     * is guaranteed to represent an enum declaration, which is a

     * kind of a class declaration.

     *

     * @return

     *      always non-null.

     */

    C getClazz();

    /**

     * Returns the base type of the enumeration.

     *

     * <p>

     * For example, with the following enum class, this method

     * returns {@link BuiltinLeafInfo} for {@link Integer}.

     *

     * <pre>

     * &XmlEnum(Integer.class)

     * enum Foo {

     *   &XmlEnumValue("1")

     *   ONE,

     *   &XmlEnumValue("2")

     *   TWO

     * }

     * </pre>

     *

     * @return

     *      never null.

     */

    NonElement<T,C> getBaseType();

    /**

     * Returns the read-only list of enumeration constants.

     *

     * @return

     *      never null. Can be empty (really?).

     */

    Iterable<? extends EnumConstant> getConstants();

}