KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > org > apache > bcel > internal > classfile > AttributeReader


1 package com.sun.org.apache.bcel.internal.classfile;
2
3 /* ====================================================================
4  * The Apache Software License, Version 1.1
5  *
6  * Copyright (c) 2001 The Apache Software Foundation. All rights
7  * reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  * notice, this list of conditions and the following disclaimer in
18  * the documentation and/or other materials provided with the
19  * distribution.
20  *
21  * 3. The end-user documentation included with the redistribution,
22  * if any, must include the following acknowledgment:
23  * "This product includes software developed by the
24  * Apache Software Foundation (http://www.apache.org/)."
25  * Alternately, this acknowledgment may appear in the software itself,
26  * if and wherever such third-party acknowledgments normally appear.
27  *
28  * 4. The names "Apache" and "Apache Software Foundation" and
29  * "Apache BCEL" must not be used to endorse or promote products
30  * derived from this software without prior written permission. For
31  * written permission, please contact apache@apache.org.
32  *
33  * 5. Products derived from this software may not be called "Apache",
34  * "Apache BCEL", nor may "Apache" appear in their name, without
35  * prior written permission of the Apache Software Foundation.
36  *
37  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
41  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48  * SUCH DAMAGE.
49  * ====================================================================
50  *
51  * This software consists of voluntary contributions made by many
52  * individuals on behalf of the Apache Software Foundation. For more
53  * information on the Apache Software Foundation, please see
54  * <http://www.apache.org/>.
55  */
56
57 /**
58  * Unknown (non-standard) attributes may be read via user-defined factory
59  * objects that can be registered with the Attribute.addAttributeReader
60  * method. These factory objects should implement this interface.
61
62  * @see Attribute
63  * @version $Id: AttributeReader.java,v 1.1.2.1 2005/07/31 23:46:22 jeffsuttor Exp $
64  * @author <A HREF="mailto:markus.dahm@berlin.de">M. Dahm</A>
65  */
66 public interface AttributeReader {
67   /**
68      When this attribute reader is added via the static method
69      Attribute.addAttributeReader, an attribute name is associated with it.
70      As the class file parser parses attributes, it will call various
71      AttributeReaders based on the name of the attributes it is
72      constructing.
73
74      @param name_index An index into the constant pool, indexing a
75      ConstantUtf8 that represents the name of the attribute.
76
77      @param length The length of the data contained in the attribute. This
78      is written into the constant pool and should agree with what the
79      factory expects the length to be.
80
81      @param file This is the data input stream that the factory needs to read
82      its data from.
83
84      @param constant_pool This is the constant pool associated with the
85      Attribute that we are constructing.
86
87      @return The user-defined AttributeReader should take this data and use
88      it to construct an attribute. In the case of errors, a null can be
89      returned which will cause the parsing of the class file to fail.
90
91      @see Attribute#addAttributeReader( String, AttributeReader )
92   */
93   public Attribute createAttribute(int name_index,
94                    int length,
95                    java.io.DataInputStream JavaDoc file,
96                    ConstantPool constant_pool);
97 }
98
Popular Tags