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