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      public INVOKESPECIAL(final int index) {
47          super(Const.INVOKESPECIAL, index);
48      }
49  
50      /**
51       * Call corresponding visitor method(s). The order is: Call visitor methods of implemented interfaces first, then call
52       * methods according to the class hierarchy in descending order, i.e., the most specific visitXXX() call comes last.
53       *
54       * @param v Visitor object
55       */
56      @Override
57      public void accept(final Visitor v) {
58          v.visitExceptionThrower(this);
59          v.visitTypedInstruction(this);
60          v.visitStackConsumer(this);
61          v.visitStackProducer(this);
62          v.visitLoadClass(this);
63          v.visitCPInstruction(this);
64          v.visitFieldOrMethod(this);
65          v.visitInvokeInstruction(this);
66          v.visitINVOKESPECIAL(this);
67      }
68  
69      /**
70       * Dump instruction as byte code to stream out.
71       *
72       * @param out Output stream
73       */
74      @Override
75      public void dump(final DataOutputStream out) throws IOException {
76          out.writeByte(super.getOpcode());
77          out.writeShort(super.getIndex());
78      }
79  
80      @Override
81      public Class<?>[] getExceptions() {
82          return ExceptionConst.createExceptions(ExceptionConst.EXCS.EXCS_FIELD_AND_METHOD_RESOLUTION, ExceptionConst.NULL_POINTER_EXCEPTION,
83              ExceptionConst.INCOMPATIBLE_CLASS_CHANGE_ERROR, ExceptionConst.ABSTRACT_METHOD_ERROR, ExceptionConst.UNSATISFIED_LINK_ERROR);
84      }
85  }