KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > tc > asm > FieldVisitor


1 /***
2  * ASM: a very small and fast Java bytecode manipulation framework
3  * Copyright (c) 2000-2005 INRIA, France Telecom
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the distribution.
14  * 3. Neither the name of the copyright holders nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
28  * THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 package com.tc.asm;
31
32 /**
33  * A visitor to visit a Java field. The methods of this interface must be called
34  * in the following order: ( <tt>visitAnnotation</tt> |
35  * <tt>visitAttribute</tt> )* <tt>visitEnd</tt>.
36  *
37  * @author Eric Bruneton
38  */
39 public interface FieldVisitor {
40
41     /**
42      * Visits an annotation of the field.
43      *
44      * @param desc the class descriptor of the annotation class.
45      * @param visible <tt>true</tt> if the annotation is visible at runtime.
46      * @return a non null visitor to visit the annotation values.
47      */
48     AnnotationVisitor visitAnnotation(String JavaDoc desc, boolean visible);
49
50     /**
51      * Visits a non standard attribute of the field.
52      *
53      * @param attr an attribute.
54      */
55     void visitAttribute(Attribute attr);
56
57     /**
58      * Visits the end of the field. This method, which is the last one to be
59      * called, is used to inform the visitor that all the annotations and
60      * attributes of the field have been visited.
61      */
62     void visitEnd();
63 }
64
Popular Tags