001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   https://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.bcel.generic;
020
021/**
022 * Denotes an unparameterized instruction to load a value from a local variable, for example ILOAD.
023 */
024public abstract class LoadInstruction extends LocalVariableInstruction implements PushInstruction {
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    LoadInstruction(final short canonTag, final short cTag) {
031        super(canonTag, cTag);
032    }
033
034    /**
035     * Constructs a LoadInstruction.
036     *
037     * @param opcode Instruction opcode.
038     * @param cTag Instruction number for compact version, ALOAD_0, for example.
039     * @param n local variable index (unsigned short).
040     */
041    protected LoadInstruction(final short opcode, final short cTag, final int n) {
042        super(opcode, cTag, n);
043    }
044
045    /**
046     * Call corresponding visitor method(s). The order is: Call visitor methods of implemented interfaces first, then call
047     * methods according to the class hierarchy in descending order, that is, the most specific visitXXX() call comes last.
048     *
049     * @param v Visitor object.
050     */
051    @Override
052    public void accept(final Visitor v) {
053        v.visitStackProducer(this);
054        v.visitPushInstruction(this);
055        v.visitTypedInstruction(this);
056        v.visitLocalVariableInstruction(this);
057        v.visitLoadInstruction(this);
058    }
059}