View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   https://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.bcel.generic;
20  
21  import java.io.DataOutputStream;
22  import java.io.IOException;
23  
24  import org.apache.bcel.Const;
25  import org.apache.bcel.ExceptionConst;
26  
27  /**
28   * INVOKESPECIAL - Invoke instance method; special handling for superclass, private and instance initialization method
29   * invocations
30   *
31   * <pre>
32   * Stack: ..., objectref, [arg1, [arg2 ...]] -&gt; ...
33   * </pre>
34   *
35   * @see <a href="https://docs.oracle.com/javase/specs/jvms/se8/html/jvms-6.html#jvms-6.5.invokespecial"> The
36   *      invokespecial instruction in The Java Virtual Machine Specification</a>
37   */
38  public class INVOKESPECIAL extends InvokeInstruction {
39  
40      /**
41       * Empty constructor needed for Instruction.readInstruction. Not to be used otherwise.
42       */
43      INVOKESPECIAL() {
44      }
45  
46      /**
47       * Constructs an INVOKESPECIAL instruction.
48       *
49       * @param index index into constant pool.
50       */
51      public INVOKESPECIAL(final int index) {
52          super(Const.INVOKESPECIAL, index);
53      }
54  
55      /**
56       * Call corresponding visitor method(s). The order is: Call visitor methods of implemented interfaces first, then call
57       * methods according to the class hierarchy in descending order, that is, the most specific visitXXX() call comes last.
58       *
59       * @param v Visitor object.
60       */
61      @Override
62      public void accept(final Visitor v) {
63          v.visitExceptionThrower(this);
64          v.visitTypedInstruction(this);
65          v.visitStackConsumer(this);
66          v.visitStackProducer(this);
67          v.visitLoadClass(this);
68          v.visitCPInstruction(this);
69          v.visitFieldOrMethod(this);
70          v.visitInvokeInstruction(this);
71          v.visitINVOKESPECIAL(this);
72      }
73  
74      /**
75       * Dumps instruction as byte code to stream out.
76       *
77       * @param out Output stream.
78       */
79      @Override
80      public void dump(final DataOutputStream out) throws IOException {
81          out.writeByte(super.getOpcode());
82          out.writeShort(super.getIndex());
83      }
84  
85      @Override
86      public Class<?>[] getExceptions() {
87          return ExceptionConst.createExceptions(ExceptionConst.EXCS.EXCS_FIELD_AND_METHOD_RESOLUTION, ExceptionConst.NULL_POINTER_EXCEPTION,
88              ExceptionConst.INCOMPATIBLE_CLASS_CHANGE_ERROR, ExceptionConst.ABSTRACT_METHOD_ERROR, ExceptionConst.UNSATISFIED_LINK_ERROR);
89      }
90  }