View Javadoc
1   /*
2    * reserved comment block
3    * DO NOT REMOVE OR ALTER!
4    */
5   package com.sun.org.apache.bcel.internal.generic;
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.classfile.ConstantPool;
62  import com.sun.org.apache.bcel.internal.classfile.ConstantUtf8;
63  import com.sun.org.apache.bcel.internal.classfile.ConstantNameAndType;
64  import com.sun.org.apache.bcel.internal.classfile.ConstantCP;
65  import com.sun.org.apache.bcel.internal.classfile.*;
66  
67  /**
68   * Super class for the GET/PUTxxx family of instructions.
69   *
70   * @author  <A HREF="mailto:markus.dahm@berlin.de">M. Dahm</A>
71   */
72  public abstract class FieldInstruction extends FieldOrMethod
73    implements TypedInstruction {
74    /**
75     * Empty constructor needed for the Class.newInstance() statement in
76     * Instruction.readInstruction(). Not to be used otherwise.
77     */
78    FieldInstruction() {}
79  
80    /**
81     * @param index to constant pool
82     */
83    protected FieldInstruction(short opcode, int index) {
84      super(opcode, index);
85    }
86  
87    /**
88     * @return mnemonic for instruction with symbolic references resolved
89     */
90    public String toString(ConstantPool cp) {
91      return com.sun.org.apache.bcel.internal.Constants.OPCODE_NAMES[opcode] + " " +
92        cp.constantToString(index, com.sun.org.apache.bcel.internal.Constants.CONSTANT_Fieldref);
93    }
94  
95    /** @return size of field (1 or 2)
96     */
97    protected int getFieldSize(ConstantPoolGen cpg) {
98      return getType(cpg).getSize();
99    }
100 
101   /** @return return type of referenced field
102    */
103   public Type getType(ConstantPoolGen cpg) {
104     return getFieldType(cpg);
105   }
106 
107   /** @return type of field
108    */
109   public Type getFieldType(ConstantPoolGen cpg) {
110     return Type.getType(getSignature(cpg));
111   }
112 
113   /** @return name of referenced field.
114    */
115   public String getFieldName(ConstantPoolGen cpg) {
116     return getName(cpg);
117   }
118 }