001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 *  Unless required by applicable law or agreed to in writing, software
012 *  distributed under the License is distributed on an "AS IS" BASIS,
013 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 *  See the License for the specific language governing permissions and
015 *  limitations under the License.
016 *
017 */
018package org.apache.bcel.generic;
019
020import java.io.DataOutputStream;
021import java.io.IOException;
022
023import org.apache.bcel.Const;
024import org.apache.bcel.ExceptionConst;
025
026/**
027 * INVOKESPECIAL - Invoke instance method; special handling for superclass, private
028 * and instance initialization method invocations
029 *
030 * <PRE>Stack: ..., objectref, [arg1, [arg2 ...]] -&gt; ...</PRE>
031 *
032 * @version $Id: INVOKESPECIAL.java 1812166 2017-10-13 23:48:11Z ggregory $
033 * @see
034 * <a href="http://docs.oracle.com/javase/specs/jvms/se8/html/jvms-6.html#jvms-6.5.invokespecial">
035 * The invokespecial instruction in The Java Virtual Machine Specification</a>
036 */
037public class INVOKESPECIAL extends InvokeInstruction {
038
039    /**
040     * Empty constructor needed for Instruction.readInstruction.
041     * Not to be used otherwise.
042     */
043    INVOKESPECIAL() {
044    }
045
046
047    public INVOKESPECIAL(final int index) {
048        super(Const.INVOKESPECIAL, index);
049    }
050
051
052    /**
053     * Dump instruction as byte code to stream out.
054     * @param out Output stream
055     */
056    @Override
057    public void dump( final DataOutputStream out ) throws IOException {
058        out.writeByte(super.getOpcode());
059        out.writeShort(super.getIndex());
060    }
061
062    @Override
063    public Class<?>[] getExceptions() {
064        return ExceptionConst.createExceptions(ExceptionConst.EXCS.EXCS_FIELD_AND_METHOD_RESOLUTION,
065            ExceptionConst.NULL_POINTER_EXCEPTION,
066            ExceptionConst.INCOMPATIBLE_CLASS_CHANGE_ERROR,
067            ExceptionConst.ABSTRACT_METHOD_ERROR,
068            ExceptionConst.UNSATISFIED_LINK_ERROR);
069    }
070
071
072    /**
073     * Call corresponding visitor method(s). The order is:
074     * Call visitor methods of implemented interfaces first, then
075     * call methods according to the class hierarchy in descending order,
076     * i.e., the most specific visitXXX() call comes last.
077     *
078     * @param v Visitor object
079     */
080    @Override
081    public void accept( final Visitor v ) {
082        v.visitExceptionThrower(this);
083        v.visitTypedInstruction(this);
084        v.visitStackConsumer(this);
085        v.visitStackProducer(this);
086        v.visitLoadClass(this);
087        v.visitCPInstruction(this);
088        v.visitFieldOrMethod(this);
089        v.visitInvokeInstruction(this);
090        v.visitINVOKESPECIAL(this);
091    }
092}