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  import  com.sun.org.apache.bcel.internal.Constants;
62  import  java.io.*;
63  
64  /**
65   * This class is derived from <em>Attribute</em> and represents a reference
66   * to a <a href="http://www.inf.fu-berlin.de/~bokowski/pmgjava/index.html">PMG</a>
67   * attribute.
68   *
69   * @author  <A HREF="mailto:markus.dahm@berlin.de">M. Dahm</A>
70   * @see     Attribute
71   */
72  public final class PMGClass extends Attribute {
73    private int pmg_class_index, pmg_index;
74  
75    /**
76     * Initialize from another object. Note that both objects use the same
77     * references (shallow copy). Use clone() for a physical copy.
78     */
79    public PMGClass(PMGClass c) {
80      this(c.getNameIndex(), c.getLength(), c.getPMGIndex(), c.getPMGClassIndex(),
81           c.getConstantPool());
82    }
83  
84    /**
85     * Construct object from file stream.
86     * @param name_index Index in constant pool to CONSTANT_Utf8
87     * @param length Content length in bytes
88     * @param file Input stream
89     * @param constant_pool Array of constants
90     * @throws IOException
91     */
92    PMGClass(int name_index, int length, DataInputStream file,
93             ConstantPool constant_pool) throws IOException
94    {
95      this(name_index, length, file.readUnsignedShort(), file.readUnsignedShort(),
96           constant_pool);
97    }
98  
99    /**
100    * @param name_index Index in constant pool to CONSTANT_Utf8
101    * @param length Content length in bytes
102    * @param constant_pool Array of constants
103    * @param PMGClass_index Index in constant pool to CONSTANT_Utf8
104    */
105   public PMGClass(int name_index, int length, int pmg_index, int pmg_class_index,
106                   ConstantPool constant_pool)
107   {
108     super(Constants.ATTR_PMG, name_index, length, constant_pool);
109     this.pmg_index       = pmg_index;
110     this.pmg_class_index = pmg_class_index;
111   }
112 
113   /**
114    * Called by objects that are traversing the nodes of the tree implicitely
115    * defined by the contents of a Java class. I.e., the hierarchy of methods,
116    * fields, attributes, etc. spawns a tree of objects.
117    *
118    * @param v Visitor object
119    */
120    public void accept(Visitor v) {
121      System.err.println("Visiting non-standard PMGClass object");
122    }
123 
124   /**
125    * Dump source file attribute to file stream in binary format.
126    *
127    * @param file Output file stream
128    * @throws IOException
129    */
130   public final void dump(DataOutputStream file) throws IOException
131   {
132     super.dump(file);
133     file.writeShort(pmg_index);
134     file.writeShort(pmg_class_index);
135   }
136 
137   /**
138    * @return Index in constant pool of source file name.
139    */
140   public final int getPMGClassIndex() { return pmg_class_index; }
141 
142   /**
143    * @param PMGClass_index.
144    */
145   public final void setPMGClassIndex(int pmg_class_index) {
146     this.pmg_class_index = pmg_class_index;
147   }
148 
149   /**
150    * @return Index in constant pool of source file name.
151    */
152   public final int getPMGIndex() { return pmg_index; }
153 
154   /**
155    * @param PMGClass_index.
156    */
157   public final void setPMGIndex(int pmg_index) {
158     this.pmg_index = pmg_index;
159   }
160 
161   /**
162    * @return PMG name.
163    */
164   public final String getPMGName() {
165     ConstantUtf8 c = (ConstantUtf8)constant_pool.getConstant(pmg_index,
166                                                              Constants.CONSTANT_Utf8);
167     return c.getBytes();
168   }
169 
170   /**
171    * @return PMG class name.
172    */
173   public final String getPMGClassName() {
174     ConstantUtf8 c = (ConstantUtf8)constant_pool.getConstant(pmg_class_index,
175                                                              Constants.CONSTANT_Utf8);
176     return c.getBytes();
177   }
178 
179   /**
180    * @return String representation
181    */
182   public final String toString() {
183     return "PMGClass(" + getPMGName() + ", " + getPMGClassName() + ")";
184   }
185 
186   /**
187    * @return deep copy of this attribute
188    */
189   public Attribute copy(ConstantPool constant_pool) {
190     return (PMGClass)clone();
191   }
192 }