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