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