Thu, 31 Aug 2017 15:18:52 +0800
merge
aoqi@0 | 1 | /* |
aoqi@0 | 2 | * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved. |
aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
aoqi@0 | 4 | * |
aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
aoqi@0 | 10 | * |
aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
aoqi@0 | 15 | * accompanied this code). |
aoqi@0 | 16 | * |
aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
aoqi@0 | 20 | * |
aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
aoqi@0 | 23 | * questions. |
aoqi@0 | 24 | */ |
aoqi@0 | 25 | |
aoqi@0 | 26 | package com.sun.xml.internal.bind.v2.model.core; |
aoqi@0 | 27 | |
aoqi@0 | 28 | import javax.xml.bind.annotation.XmlEnumValue; |
aoqi@0 | 29 | |
aoqi@0 | 30 | /** |
aoqi@0 | 31 | * Individual constant of an enumeration. |
aoqi@0 | 32 | * |
aoqi@0 | 33 | * <p> |
aoqi@0 | 34 | * Javadoc in this class uses the following sample to explain the semantics: |
aoqi@0 | 35 | * <pre> |
aoqi@0 | 36 | * @XmlEnum(Integer.class) |
aoqi@0 | 37 | * enum Foo { |
aoqi@0 | 38 | * @XmlEnumValue("1") |
aoqi@0 | 39 | * ONE, |
aoqi@0 | 40 | * @XmlEnumValue("2") |
aoqi@0 | 41 | * TWO |
aoqi@0 | 42 | * } |
aoqi@0 | 43 | * </pre> |
aoqi@0 | 44 | * |
aoqi@0 | 45 | * @see EnumLeafInfo |
aoqi@0 | 46 | * @author Kohsuke Kawaguchi |
aoqi@0 | 47 | */ |
aoqi@0 | 48 | public interface EnumConstant<T,C> { |
aoqi@0 | 49 | |
aoqi@0 | 50 | /** |
aoqi@0 | 51 | * Gets the {@link EnumLeafInfo} to which this constant belongs to. |
aoqi@0 | 52 | * |
aoqi@0 | 53 | * @return never null. |
aoqi@0 | 54 | */ |
aoqi@0 | 55 | EnumLeafInfo<T,C> getEnclosingClass(); |
aoqi@0 | 56 | |
aoqi@0 | 57 | /** |
aoqi@0 | 58 | * Lexical value of this constant. |
aoqi@0 | 59 | * |
aoqi@0 | 60 | * <p> |
aoqi@0 | 61 | * This value should be evaluated against |
aoqi@0 | 62 | * {@link EnumLeafInfo#getBaseType()} to obtain the typed value. |
aoqi@0 | 63 | * |
aoqi@0 | 64 | * <p> |
aoqi@0 | 65 | * This is the same value as written in the {@link XmlEnumValue} annotation. |
aoqi@0 | 66 | * In the above example, this method returns "1" and "2". |
aoqi@0 | 67 | * |
aoqi@0 | 68 | * @return |
aoqi@0 | 69 | * never null. |
aoqi@0 | 70 | */ |
aoqi@0 | 71 | String getLexicalValue(); |
aoqi@0 | 72 | |
aoqi@0 | 73 | /** |
aoqi@0 | 74 | * Gets the constant name. |
aoqi@0 | 75 | * |
aoqi@0 | 76 | * <p> |
aoqi@0 | 77 | * In the above example this method return "ONE" and "TWO". |
aoqi@0 | 78 | * |
aoqi@0 | 79 | * @return |
aoqi@0 | 80 | * never null. A valid Java identifier. |
aoqi@0 | 81 | */ |
aoqi@0 | 82 | String getName(); |
aoqi@0 | 83 | } |