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   * INVOKEVIRTUAL - Invoke instance method; dispatch based on class
27   *
28   * <PRE>
29   * Stack: ..., objectref, [arg1, [arg2 ...]] -&gt; ...
30   * </PRE>
31   *
32   * @see <a href="https://docs.oracle.com/javase/specs/jvms/se8/html/jvms-6.html#jvms-6.5.invokevirtual"> The
33   *      invokevirtual instruction in The Java Virtual Machine Specification</a>
34   */
35  public class INVOKEVIRTUAL extends InvokeInstruction {
36  
37      /**
38       * Empty constructor needed for Instruction.readInstruction. Not to be used otherwise.
39       */
40      INVOKEVIRTUAL() {
41      }
42  
43      public INVOKEVIRTUAL(final int index) {
44          super(Const.INVOKEVIRTUAL, index);
45      }
46  
47      /**
48       * Call corresponding visitor method(s). The order is: Call visitor methods of implemented interfaces first, then call
49       * methods according to the class hierarchy in descending order, i.e., the most specific visitXXX() call comes last.
50       *
51       * @param v Visitor object
52       */
53      @Override
54      public void accept(final Visitor v) {
55          v.visitExceptionThrower(this);
56          v.visitTypedInstruction(this);
57          v.visitStackConsumer(this);
58          v.visitStackProducer(this);
59          v.visitLoadClass(this);
60          v.visitCPInstruction(this);
61          v.visitFieldOrMethod(this);
62          v.visitInvokeInstruction(this);
63          v.visitINVOKEVIRTUAL(this);
64      }
65  
66      /**
67       * Dump instruction as byte code to stream out.
68       *
69       * @param out Output stream
70       */
71      @Override
72      public void dump(final DataOutputStream out) throws IOException {
73          out.writeByte(super.getOpcode());
74          out.writeShort(super.getIndex());
75      }
76  
77      @Override
78      public Class<?>[] getExceptions() {
79          return ExceptionConst.createExceptions(ExceptionConst.EXCS.EXCS_FIELD_AND_METHOD_RESOLUTION, ExceptionConst.NULL_POINTER_EXCEPTION,
80              ExceptionConst.INCOMPATIBLE_CLASS_CHANGE_ERROR, ExceptionConst.ABSTRACT_METHOD_ERROR, ExceptionConst.UNSATISFIED_LINK_ERROR);
81      }
82  }