View Javadoc

1   /*
2    * org.osjava.jardiff.ClassInfoVisitor
3    *
4    * $Id: IOThread.java 1952 2005-08-28 18:03:41Z cybertiger $
5    * $URL: https://svn.osjava.org/svn/osjava/trunk/osjava-nio/src/java/org/osjava/nio/IOThread.java $
6    * $Rev: 1952 $
7    * $Date: 2005-08-28 18:03:41 +0000 (Sun, 28 Aug 2005) $
8    * $Author: cybertiger $
9    *
10   * Copyright (c) 2005, Antony Riley
11   * All rights reserved.
12   *
13   * Redistribution and use in source and binary forms, with or without
14   * modification, are permitted provided that the following conditions are met:
15   *
16   * + Redistributions of source code must retain the above copyright notice,
17   *   this list of conditions and the following disclaimer.
18   *
19   * + Redistributions in binary form must reproduce the above copyright notice,
20   *   this list of conditions and the following disclaimer in the documentation
21   *   and/or other materials provided with the distribution.
22   *
23   * + Neither the name JarDiff nor the names of its contributors may
24   *   be used to endorse or promote products derived from this software without
25   *   specific prior written permission.
26   *
27   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
28   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30   * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
31   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37   * POSSIBILITY OF SUCH DAMAGE.
38   */
39  package org.osjava.jardiff;
40  import java.util.HashMap;
41  import java.util.Map;
42  
43  import org.objectweb.asm.FieldVisitor;
44  import org.objectweb.asm.MethodVisitor;
45  import org.objectweb.asm.commons.EmptyVisitor;
46  
47  /***
48   * A reusable class which uses the ASM to build up ClassInfo about a 
49   * java class file.
50   *
51   * @author <a href="mailto:antony@cyberiantiger.org">Antony Riley</a>
52   */
53  public class ClassInfoVisitor extends EmptyVisitor
54  {
55      /***
56       * The class file version.
57       */
58      private int version;
59  
60      /***
61       * The access flags for the class.
62       */
63  
64      private int access;
65  
66      /***
67       * The internal name of the class.
68       */
69      private String name;
70  
71      /***
72       * The signature of the class
73       */
74      private String signature;
75      
76      /***
77       * The internal name of the superclass.
78       */
79      private String supername;
80  
81      /***
82       * An array of internal names of interfaces implemented by this class.
83       */
84      private String[] interfaces;
85  
86      /***
87       * A map of method signature to a MethodInfo describing the method.
88       */
89      private Map methodMap;
90  
91      /***
92       * A map of field signature to a FieldInfo describing the field.
93       */
94      private Map fieldMap;
95      
96      /***
97       * Reset this ClassInfoVisitor so that it can be used to visit another
98       * class.
99       */
100     public void reset() {
101         methodMap = new HashMap();
102         fieldMap = new HashMap();
103     }
104     
105     /***
106      * The the classInfo this ClassInfoVisitor has built up about a class
107      */
108     public ClassInfo getClassInfo() {
109         return new ClassInfo(version, access, name, signature, supername,
110                              interfaces, methodMap, fieldMap);
111     }
112     
113     /***
114      * Receive notification of information about a class from ASM.
115      *
116      * @param version the class file version number.
117      * @param access the access flags for the class.
118      * @param name the internal name of the class.
119      * @param signature the signature of the class.
120      * @param supername the internal name of the super class.
121      * @param interfaces the internal names of interfaces implemented.
122      */
123     public void visit(int version, int access, String name, String signature,
124                       String supername, String[] interfaces) {
125         this.version = version;
126         this.access = access;
127         this.name = name;
128         this.signature = signature;
129         this.supername = supername;
130         this.interfaces = interfaces;
131     }
132     
133     public MethodVisitor visitMethod(int access, String name, String desc,
134                                      String signature, String[] exceptions) {
135         methodMap.put(name + desc, new MethodInfo(access, name, desc,
136                                                   signature, exceptions));
137         return null;
138     }
139     
140     public FieldVisitor visitField(int access, String name, String desc,
141                                    String signature, Object value) {
142         fieldMap.put(name,
143                      new FieldInfo(access, name, desc, signature, value));
144         return this;
145     }
146 }