langtools/src/share/classes/com/sun/tools/apt/mirror/declaration/AnnotationMirrorImpl.java
author darcy
Sun, 26 Jul 2009 21:27:11 -0700
changeset 3378 22011d9a9398
parent 10 06bc494ca11e
child 5520 86e4b9a9da40
permissions -rw-r--r--
6381698: Warn of decommissioning of apt Reviewed-by: jjg
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     1
/*
06bc494ca11e Initial load
duke
parents:
diff changeset
     2
 * Copyright 2004 Sun Microsystems, Inc.  All Rights Reserved.
06bc494ca11e Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
06bc494ca11e Initial load
duke
parents:
diff changeset
     4
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
06bc494ca11e Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
06bc494ca11e Initial load
duke
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Sun designates this
06bc494ca11e Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
06bc494ca11e Initial load
duke
parents:
diff changeset
     9
 * by Sun in the LICENSE file that accompanied this code.
06bc494ca11e Initial load
duke
parents:
diff changeset
    10
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
06bc494ca11e Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
06bc494ca11e Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
06bc494ca11e Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
06bc494ca11e Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
06bc494ca11e Initial load
duke
parents:
diff changeset
    16
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
06bc494ca11e Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
06bc494ca11e Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
06bc494ca11e Initial load
duke
parents:
diff changeset
    20
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    21
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
06bc494ca11e Initial load
duke
parents:
diff changeset
    22
 * CA 95054 USA or visit www.sun.com if you need additional information or
06bc494ca11e Initial load
duke
parents:
diff changeset
    23
 * have any questions.
06bc494ca11e Initial load
duke
parents:
diff changeset
    24
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    25
06bc494ca11e Initial load
duke
parents:
diff changeset
    26
package com.sun.tools.apt.mirror.declaration;
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
06bc494ca11e Initial load
duke
parents:
diff changeset
    28
06bc494ca11e Initial load
duke
parents:
diff changeset
    29
import java.util.LinkedHashMap;
06bc494ca11e Initial load
duke
parents:
diff changeset
    30
import java.util.Map;
06bc494ca11e Initial load
duke
parents:
diff changeset
    31
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
import com.sun.mirror.declaration.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
import com.sun.mirror.type.AnnotationType;
06bc494ca11e Initial load
duke
parents:
diff changeset
    34
import com.sun.mirror.util.SourcePosition;
06bc494ca11e Initial load
duke
parents:
diff changeset
    35
import com.sun.tools.apt.mirror.AptEnv;
06bc494ca11e Initial load
duke
parents:
diff changeset
    36
import com.sun.tools.javac.code.Attribute;
06bc494ca11e Initial load
duke
parents:
diff changeset
    37
import com.sun.tools.javac.code.Symbol.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    38
import com.sun.tools.javac.util.Name;
06bc494ca11e Initial load
duke
parents:
diff changeset
    39
import com.sun.tools.javac.util.Pair;
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
06bc494ca11e Initial load
duke
parents:
diff changeset
    41
06bc494ca11e Initial load
duke
parents:
diff changeset
    42
/**
06bc494ca11e Initial load
duke
parents:
diff changeset
    43
 * Implementation of AnnotationMirror
06bc494ca11e Initial load
duke
parents:
diff changeset
    44
 */
3378
22011d9a9398 6381698: Warn of decommissioning of apt
darcy
parents: 10
diff changeset
    45
@SuppressWarnings("deprecation")
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    46
public class AnnotationMirrorImpl implements AnnotationMirror {
06bc494ca11e Initial load
duke
parents:
diff changeset
    47
06bc494ca11e Initial load
duke
parents:
diff changeset
    48
    protected final AptEnv env;
06bc494ca11e Initial load
duke
parents:
diff changeset
    49
    protected final Attribute.Compound anno;
06bc494ca11e Initial load
duke
parents:
diff changeset
    50
    protected final Declaration decl;
06bc494ca11e Initial load
duke
parents:
diff changeset
    51
06bc494ca11e Initial load
duke
parents:
diff changeset
    52
06bc494ca11e Initial load
duke
parents:
diff changeset
    53
    AnnotationMirrorImpl(AptEnv env, Attribute.Compound anno, Declaration decl) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    54
        this.env = env;
06bc494ca11e Initial load
duke
parents:
diff changeset
    55
        this.anno = anno;
06bc494ca11e Initial load
duke
parents:
diff changeset
    56
        this.decl = decl;
06bc494ca11e Initial load
duke
parents:
diff changeset
    57
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    58
06bc494ca11e Initial load
duke
parents:
diff changeset
    59
06bc494ca11e Initial load
duke
parents:
diff changeset
    60
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    61
     * Returns a string representation of this annotation.
06bc494ca11e Initial load
duke
parents:
diff changeset
    62
     * String is of one of the forms:
06bc494ca11e Initial load
duke
parents:
diff changeset
    63
     *     @com.example.foo(name1=val1, name2=val2)
06bc494ca11e Initial load
duke
parents:
diff changeset
    64
     *     @com.example.foo(val)
06bc494ca11e Initial load
duke
parents:
diff changeset
    65
     *     @com.example.foo
06bc494ca11e Initial load
duke
parents:
diff changeset
    66
     * Omit parens for marker annotations, and omit "value=" when allowed.
06bc494ca11e Initial load
duke
parents:
diff changeset
    67
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    68
    public String toString() {
06bc494ca11e Initial load
duke
parents:
diff changeset
    69
        StringBuilder sb = new StringBuilder("@");
06bc494ca11e Initial load
duke
parents:
diff changeset
    70
        Constants.Formatter fmtr = Constants.getFormatter(sb);
06bc494ca11e Initial load
duke
parents:
diff changeset
    71
06bc494ca11e Initial load
duke
parents:
diff changeset
    72
        fmtr.append(anno.type.tsym);
06bc494ca11e Initial load
duke
parents:
diff changeset
    73
06bc494ca11e Initial load
duke
parents:
diff changeset
    74
        int len = anno.values.length();
06bc494ca11e Initial load
duke
parents:
diff changeset
    75
        if (len > 0) {          // omit parens for marker annotations
06bc494ca11e Initial load
duke
parents:
diff changeset
    76
            sb.append('(');
06bc494ca11e Initial load
duke
parents:
diff changeset
    77
            boolean first = true;
06bc494ca11e Initial load
duke
parents:
diff changeset
    78
            for (Pair<MethodSymbol, Attribute> val : anno.values) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    79
                if (!first) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    80
                    sb.append(", ");
06bc494ca11e Initial load
duke
parents:
diff changeset
    81
                }
06bc494ca11e Initial load
duke
parents:
diff changeset
    82
                first = false;
06bc494ca11e Initial load
duke
parents:
diff changeset
    83
06bc494ca11e Initial load
duke
parents:
diff changeset
    84
                Name name = val.fst.name;
06bc494ca11e Initial load
duke
parents:
diff changeset
    85
                if (len > 1 || name != env.names.value) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    86
                    fmtr.append(name);
06bc494ca11e Initial load
duke
parents:
diff changeset
    87
                    sb.append('=');
06bc494ca11e Initial load
duke
parents:
diff changeset
    88
                }
06bc494ca11e Initial load
duke
parents:
diff changeset
    89
                sb.append(new AnnotationValueImpl(env, val.snd, this));
06bc494ca11e Initial load
duke
parents:
diff changeset
    90
            }
06bc494ca11e Initial load
duke
parents:
diff changeset
    91
            sb.append(')');
06bc494ca11e Initial load
duke
parents:
diff changeset
    92
        }
06bc494ca11e Initial load
duke
parents:
diff changeset
    93
        return fmtr.toString();
06bc494ca11e Initial load
duke
parents:
diff changeset
    94
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    95
06bc494ca11e Initial load
duke
parents:
diff changeset
    96
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    97
     * {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
    98
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    99
    public AnnotationType getAnnotationType() {
06bc494ca11e Initial load
duke
parents:
diff changeset
   100
        return (AnnotationType) env.typeMaker.getType(anno.type);
06bc494ca11e Initial load
duke
parents:
diff changeset
   101
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   102
06bc494ca11e Initial load
duke
parents:
diff changeset
   103
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   104
     * {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   105
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   106
    public Map<AnnotationTypeElementDeclaration, AnnotationValue>
06bc494ca11e Initial load
duke
parents:
diff changeset
   107
                                                        getElementValues() {
06bc494ca11e Initial load
duke
parents:
diff changeset
   108
        Map<AnnotationTypeElementDeclaration, AnnotationValue> res =
06bc494ca11e Initial load
duke
parents:
diff changeset
   109
            new LinkedHashMap<AnnotationTypeElementDeclaration,
06bc494ca11e Initial load
duke
parents:
diff changeset
   110
                                                   AnnotationValue>(); // whew!
06bc494ca11e Initial load
duke
parents:
diff changeset
   111
        for (Pair<MethodSymbol, Attribute> val : anno.values) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   112
            res.put(getElement(val.fst),
06bc494ca11e Initial load
duke
parents:
diff changeset
   113
                    new AnnotationValueImpl(env, val.snd, this));
06bc494ca11e Initial load
duke
parents:
diff changeset
   114
        }
06bc494ca11e Initial load
duke
parents:
diff changeset
   115
        return res;
06bc494ca11e Initial load
duke
parents:
diff changeset
   116
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   117
06bc494ca11e Initial load
duke
parents:
diff changeset
   118
    public SourcePosition getPosition() {
06bc494ca11e Initial load
duke
parents:
diff changeset
   119
        // Return position of the declaration on which this annotation
06bc494ca11e Initial load
duke
parents:
diff changeset
   120
        // appears.
06bc494ca11e Initial load
duke
parents:
diff changeset
   121
        return (decl == null) ? null : decl.getPosition();
06bc494ca11e Initial load
duke
parents:
diff changeset
   122
06bc494ca11e Initial load
duke
parents:
diff changeset
   123
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   124
06bc494ca11e Initial load
duke
parents:
diff changeset
   125
    public Declaration getDeclaration() {
06bc494ca11e Initial load
duke
parents:
diff changeset
   126
        return this.decl;
06bc494ca11e Initial load
duke
parents:
diff changeset
   127
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   128
06bc494ca11e Initial load
duke
parents:
diff changeset
   129
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   130
     * Returns the annotation type element for a symbol.
06bc494ca11e Initial load
duke
parents:
diff changeset
   131
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   132
    private AnnotationTypeElementDeclaration getElement(MethodSymbol m) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   133
        return (AnnotationTypeElementDeclaration)
06bc494ca11e Initial load
duke
parents:
diff changeset
   134
                    env.declMaker.getExecutableDeclaration(m);
06bc494ca11e Initial load
duke
parents:
diff changeset
   135
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   136
}