Thu, 12 Oct 2017 19:44:07 +0800
merge
aoqi@0 | 1 | /* |
aoqi@0 | 2 | * Copyright (c) 1997, 2010, 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.codemodel.internal; |
aoqi@0 | 27 | |
aoqi@0 | 28 | import java.util.ArrayList; |
aoqi@0 | 29 | import java.util.List; |
aoqi@0 | 30 | import java.util.Collection; |
aoqi@0 | 31 | import java.util.Collections; |
aoqi@0 | 32 | import java.lang.annotation.Annotation; |
aoqi@0 | 33 | |
aoqi@0 | 34 | /** |
aoqi@0 | 35 | * Enum Constant. |
aoqi@0 | 36 | * |
aoqi@0 | 37 | * When used as an {@link JExpression}, this object represents a reference to the enum constant. |
aoqi@0 | 38 | * |
aoqi@0 | 39 | * @author |
aoqi@0 | 40 | * Bhakti Mehta (Bhakti.Mehta@sun.com) |
aoqi@0 | 41 | */ |
aoqi@0 | 42 | public final class JEnumConstant extends JExpressionImpl implements JDeclaration, JAnnotatable, JDocCommentable { |
aoqi@0 | 43 | |
aoqi@0 | 44 | /** |
aoqi@0 | 45 | * The constant. |
aoqi@0 | 46 | */ |
aoqi@0 | 47 | private final String name; |
aoqi@0 | 48 | /** |
aoqi@0 | 49 | * The enum class. |
aoqi@0 | 50 | */ |
aoqi@0 | 51 | private final JDefinedClass type; |
aoqi@0 | 52 | /** |
aoqi@0 | 53 | * javadoc comments, if any. |
aoqi@0 | 54 | */ |
aoqi@0 | 55 | private JDocComment jdoc = null; |
aoqi@0 | 56 | |
aoqi@0 | 57 | /** |
aoqi@0 | 58 | * Annotations on this variable. Lazily created. |
aoqi@0 | 59 | */ |
aoqi@0 | 60 | private List<JAnnotationUse> annotations = null; |
aoqi@0 | 61 | |
aoqi@0 | 62 | |
aoqi@0 | 63 | /** |
aoqi@0 | 64 | * List of the constructor argument expressions. |
aoqi@0 | 65 | * Lazily constructed. |
aoqi@0 | 66 | */ |
aoqi@0 | 67 | private List<JExpression> args = null; |
aoqi@0 | 68 | |
aoqi@0 | 69 | JEnumConstant(JDefinedClass type,String name) { |
aoqi@0 | 70 | this.name = name; |
aoqi@0 | 71 | this.type = type; |
aoqi@0 | 72 | } |
aoqi@0 | 73 | |
aoqi@0 | 74 | /** |
aoqi@0 | 75 | * Add an expression to this constructor's argument list |
aoqi@0 | 76 | * |
aoqi@0 | 77 | * @param arg |
aoqi@0 | 78 | * Argument to add to argument list |
aoqi@0 | 79 | */ |
aoqi@0 | 80 | public JEnumConstant arg(JExpression arg) { |
aoqi@0 | 81 | if(arg==null) throw new IllegalArgumentException(); |
aoqi@0 | 82 | if(args==null) |
aoqi@0 | 83 | args = new ArrayList<JExpression>(); |
aoqi@0 | 84 | args.add(arg); |
aoqi@0 | 85 | return this; |
aoqi@0 | 86 | } |
aoqi@0 | 87 | |
aoqi@0 | 88 | /** |
aoqi@0 | 89 | * Returns the name of this constant. |
aoqi@0 | 90 | * |
aoqi@0 | 91 | * @return never null. |
aoqi@0 | 92 | */ |
aoqi@0 | 93 | public String getName() { |
aoqi@0 | 94 | return this.type.fullName().concat(".").concat(this.name); |
aoqi@0 | 95 | } |
aoqi@0 | 96 | |
aoqi@0 | 97 | /** |
aoqi@0 | 98 | * Creates, if necessary, and returns the enum constant javadoc. |
aoqi@0 | 99 | * |
aoqi@0 | 100 | * @return JDocComment containing javadocs for this constant. |
aoqi@0 | 101 | */ |
aoqi@0 | 102 | public JDocComment javadoc() { |
aoqi@0 | 103 | if (jdoc == null) |
aoqi@0 | 104 | jdoc = new JDocComment(type.owner()); |
aoqi@0 | 105 | return jdoc; |
aoqi@0 | 106 | } |
aoqi@0 | 107 | |
aoqi@0 | 108 | /** |
aoqi@0 | 109 | * Adds an annotation to this variable. |
aoqi@0 | 110 | * @param clazz |
aoqi@0 | 111 | * The annotation class to annotate the field with |
aoqi@0 | 112 | */ |
aoqi@0 | 113 | public JAnnotationUse annotate(JClass clazz){ |
aoqi@0 | 114 | if(annotations==null) |
aoqi@0 | 115 | annotations = new ArrayList<JAnnotationUse>(); |
aoqi@0 | 116 | JAnnotationUse a = new JAnnotationUse(clazz); |
aoqi@0 | 117 | annotations.add(a); |
aoqi@0 | 118 | return a; |
aoqi@0 | 119 | } |
aoqi@0 | 120 | |
aoqi@0 | 121 | /** |
aoqi@0 | 122 | * Adds an annotation to this variable. |
aoqi@0 | 123 | * |
aoqi@0 | 124 | * @param clazz |
aoqi@0 | 125 | * The annotation class to annotate the field with |
aoqi@0 | 126 | */ |
aoqi@0 | 127 | public JAnnotationUse annotate(Class <? extends Annotation> clazz){ |
aoqi@0 | 128 | return annotate(type.owner().ref(clazz)); |
aoqi@0 | 129 | } |
aoqi@0 | 130 | |
aoqi@0 | 131 | public <W extends JAnnotationWriter> W annotate2(Class<W> clazz) { |
aoqi@0 | 132 | return TypedAnnotationWriter.create(clazz,this); |
aoqi@0 | 133 | } |
aoqi@0 | 134 | |
aoqi@0 | 135 | /** |
aoqi@0 | 136 | * {@link JAnnotatable#annotations()} |
aoqi@0 | 137 | */ |
aoqi@0 | 138 | public Collection<JAnnotationUse> annotations() { |
aoqi@0 | 139 | if (annotations == null) |
aoqi@0 | 140 | annotations = new ArrayList<JAnnotationUse>(); |
aoqi@0 | 141 | return Collections.unmodifiableList(annotations); |
aoqi@0 | 142 | } |
aoqi@0 | 143 | |
aoqi@0 | 144 | public void declare(JFormatter f) { |
aoqi@0 | 145 | if( jdoc != null ) |
aoqi@0 | 146 | f.nl().g( jdoc ); |
aoqi@0 | 147 | if (annotations != null) { |
aoqi@0 | 148 | for( int i=0; i<annotations.size(); i++ ) |
aoqi@0 | 149 | f.g(annotations.get(i)).nl(); |
aoqi@0 | 150 | } |
aoqi@0 | 151 | f.id(name); |
aoqi@0 | 152 | if(args!=null) { |
aoqi@0 | 153 | f.p('(').g(args).p(')'); |
aoqi@0 | 154 | } |
aoqi@0 | 155 | } |
aoqi@0 | 156 | |
aoqi@0 | 157 | public void generate(JFormatter f) { |
aoqi@0 | 158 | f.t(type).p('.').p(name); |
aoqi@0 | 159 | } |
aoqi@0 | 160 | } |