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