1/*
2 * ProGuard -- shrinking, optimization, obfuscation, and preverification
3 *             of Java bytecode.
4 *
5 * Copyright (c) 2002-2014 Eric Lafortune (eric@graphics.cornell.edu)
6 *
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the Free
9 * Software Foundation; either version 2 of the License, or (at your option)
10 * any later version.
11 *
12 * This program is distributed in the hope that it will be useful, but WITHOUT
13 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 * more details.
16 *
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 */
21package proguard.classfile.attribute.annotation;
22
23import proguard.classfile.*;
24import proguard.classfile.attribute.annotation.visitor.ElementValueVisitor;
25import proguard.classfile.visitor.ClassVisitor;
26
27/**
28 * Representation of an annotation.
29 *
30 * @author Eric Lafortune
31 */
32public class Annotation implements VisitorAccepter
33{
34    public int            u2typeIndex;
35    public int            u2elementValuesCount;
36    public ElementValue[] elementValues;
37
38    /**
39     * An extra field pointing to the Clazz objects referenced in the
40     * type string. This field is typically filled out by the <code>{@link
41     * proguard.classfile.util.ClassReferenceInitializer
42     * ClassReferenceInitializer}</code>.
43     * References to primitive types are ignored.
44     */
45    public Clazz[] referencedClasses;
46
47    /**
48     * An extra field in which visitors can store information.
49     */
50    public Object visitorInfo;
51
52
53    /**
54     * Creates an uninitialized Annotation.
55     */
56    public Annotation()
57    {
58    }
59
60
61    /**
62     * Creates an initialized Annotation.
63     */
64    public Annotation(int            u2typeIndex,
65                      int            u2elementValuesCount,
66                      ElementValue[] elementValues)
67    {
68        this.u2typeIndex          = u2typeIndex;
69        this.u2elementValuesCount = u2elementValuesCount;
70        this.elementValues        = elementValues;
71    }
72
73
74    /**
75     * Returns the type.
76     */
77    public String getType(Clazz clazz)
78    {
79        return clazz.getString(u2typeIndex);
80    }
81
82
83
84    /**
85     * Applies the given visitor to the first referenced class. This is the
86     * main annotation class.
87     */
88    public void referencedClassAccept(ClassVisitor classVisitor)
89    {
90        if (referencedClasses != null)
91        {
92            Clazz referencedClass = referencedClasses[0];
93            if (referencedClass != null)
94            {
95                referencedClass.accept(classVisitor);
96            }
97        }
98    }
99
100
101    /**
102     * Applies the given visitor to all referenced classes.
103     */
104    public void referencedClassesAccept(ClassVisitor classVisitor)
105    {
106        if (referencedClasses != null)
107        {
108            for (int index = 0; index < referencedClasses.length; index++)
109            {
110                Clazz referencedClass = referencedClasses[index];
111                if (referencedClass != null)
112                {
113                    referencedClass.accept(classVisitor);
114                }
115            }
116        }
117    }
118
119
120    /**
121     * Applies the given visitor to all element value pairs.
122     */
123    public void elementValuesAccept(Clazz clazz, ElementValueVisitor elementValueVisitor)
124    {
125        for (int index = 0; index < u2elementValuesCount; index++)
126        {
127            elementValues[index].accept(clazz, this, elementValueVisitor);
128        }
129    }
130
131
132    // Implementations for VisitorAccepter.
133
134    public Object getVisitorInfo()
135    {
136        return visitorInfo;
137    }
138
139    public void setVisitorInfo(Object visitorInfo)
140    {
141        this.visitorInfo = visitorInfo;
142    }
143}
144