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