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
021import java.io.DataOutputStream;
022import java.io.IOException;
023
024import org.apache.bcel.util.ByteSequence;
025
026/**
027 * BIPUSH - Push byte on stack
028 *
029 * <PRE>
030 * Stack: ... -&gt; ..., value
031 * </PRE>
032 */
033public class BIPUSH extends Instruction implements ConstantPushInstruction {
034
035    private byte b;
036
037    /**
038     * Empty constructor needed for Instruction.readInstruction. Not to be used otherwise.
039     */
040    BIPUSH() {
041    }
042
043    /**
044     * Push byte on stack
045     */
046    public BIPUSH(final byte b) {
047        super(org.apache.bcel.Const.BIPUSH, (short) 2);
048        this.b = b;
049    }
050
051    /**
052     * Call corresponding visitor method(s). The order is: Call visitor methods of implemented interfaces first, then call
053     * methods according to the class hierarchy in descending order, i.e., the most specific visitXXX() call comes last.
054     *
055     * @param v Visitor object
056     */
057    @Override
058    public void accept(final Visitor v) {
059        v.visitPushInstruction(this);
060        v.visitStackProducer(this);
061        v.visitTypedInstruction(this);
062        v.visitConstantPushInstruction(this);
063        v.visitBIPUSH(this);
064    }
065
066    /**
067     * Dump instruction as byte code to stream out.
068     */
069    @Override
070    public void dump(final DataOutputStream out) throws IOException {
071        super.dump(out);
072        out.writeByte(b);
073    }
074
075    /**
076     * @return Type.BYTE
077     */
078    @Override
079    public Type getType(final ConstantPoolGen cp) {
080        return Type.BYTE;
081    }
082
083    @Override
084    public Number getValue() {
085        return Integer.valueOf(b);
086    }
087
088    /**
089     * Reads needed data (for example index) from file.
090     */
091    @Override
092    protected void initFromFile(final ByteSequence bytes, final boolean wide) throws IOException {
093        super.setLength(2);
094        b = bytes.readByte();
095    }
096
097    /**
098     * @return mnemonic for instruction
099     */
100    @Override
101    public String toString(final boolean verbose) {
102        return super.toString(verbose) + " " + b;
103    }
104}