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 and instance initialization method
028 * invocations
029 *
030 * <PRE>
031 * Stack: ..., objectref, [arg1, [arg2 ...]] -&gt; ...
032 * </PRE>
033 *
034 * @see <a href="https://docs.oracle.com/javase/specs/jvms/se8/html/jvms-6.html#jvms-6.5.invokespecial"> The
035 *      invokespecial instruction in The Java Virtual Machine Specification</a>
036 */
037public class INVOKESPECIAL extends InvokeInstruction {
038
039    /**
040     * Empty constructor needed for Instruction.readInstruction. Not to be used otherwise.
041     */
042    INVOKESPECIAL() {
043    }
044
045    public INVOKESPECIAL(final int index) {
046        super(Const.INVOKESPECIAL, index);
047    }
048
049    /**
050     * Call corresponding visitor method(s). The order is: Call visitor methods of implemented interfaces first, then call
051     * methods according to the class hierarchy in descending order, i.e., the most specific visitXXX() call comes last.
052     *
053     * @param v Visitor object
054     */
055    @Override
056    public void accept(final Visitor v) {
057        v.visitExceptionThrower(this);
058        v.visitTypedInstruction(this);
059        v.visitStackConsumer(this);
060        v.visitStackProducer(this);
061        v.visitLoadClass(this);
062        v.visitCPInstruction(this);
063        v.visitFieldOrMethod(this);
064        v.visitInvokeInstruction(this);
065        v.visitINVOKESPECIAL(this);
066    }
067
068    /**
069     * Dump instruction as byte code to stream out.
070     *
071     * @param out Output stream
072     */
073    @Override
074    public void dump(final DataOutputStream out) throws IOException {
075        out.writeByte(super.getOpcode());
076        out.writeShort(super.getIndex());
077    }
078
079    @Override
080    public Class<?>[] getExceptions() {
081        return ExceptionConst.createExceptions(ExceptionConst.EXCS.EXCS_FIELD_AND_METHOD_RESOLUTION, ExceptionConst.NULL_POINTER_EXCEPTION,
082            ExceptionConst.INCOMPATIBLE_CLASS_CHANGE_ERROR, ExceptionConst.ABSTRACT_METHOD_ERROR, ExceptionConst.UNSATISFIED_LINK_ERROR);
083    }
084}