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
020/**
021 * Denotes an unparameterized instruction to store a value into a local variable,
022 * e.g. ISTORE.
023 *
024 * @version $Id: StoreInstruction.java 1747278 2016-06-07 17:28:43Z britter $
025 */
026public abstract class StoreInstruction extends LocalVariableInstruction implements PopInstruction {
027
028    /**
029     * Empty constructor needed for the Class.newInstance() statement in
030     * Instruction.readInstruction(). Not to be used otherwise.
031     * tag and length are defined in readInstruction and initFromFile, respectively.
032     */
033    StoreInstruction(final short canon_tag, final short c_tag) {
034        super(canon_tag, c_tag);
035    }
036
037
038    /**
039     * @param opcode Instruction opcode
040     * @param c_tag Instruction number for compact version, ASTORE_0, e.g.
041     * @param n local variable index (unsigned short)
042     */
043    protected StoreInstruction(final short opcode, final short c_tag, final int n) {
044        super(opcode, c_tag, n);
045    }
046
047
048    /**
049     * Call corresponding visitor method(s). The order is:
050     * Call visitor methods of implemented interfaces first, then
051     * call methods according to the class hierarchy in descending order,
052     * i.e., the most specific visitXXX() call comes last.
053     *
054     * @param v Visitor object
055     */
056    @Override
057    public void accept( final Visitor v ) {
058        v.visitStackConsumer(this);
059        v.visitPopInstruction(this);
060        v.visitTypedInstruction(this);
061        v.visitLocalVariableInstruction(this);
062        v.visitStoreInstruction(this);
063    }
064}