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