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 * ICONST - Push value between -1, ..., 5, other values cause an exception
023 *
024 * <PRE>
025 * Stack: ... -&gt; ...,
026 * </PRE>
027 */
028public class ICONST extends Instruction implements ConstantPushInstruction {
029
030    private final int value;
031
032    /**
033     * Empty constructor needed for Instruction.readInstruction. Not to be used otherwise.
034     */
035    ICONST() {
036        this(0);
037    }
038
039    /**
040     * Constructs an ICONST instruction.
041     *
042     * @param i the integer value.
043     */
044    public ICONST(final int i) {
045        super(org.apache.bcel.Const.ICONST_0, (short) 1);
046        if (i < -1 || i > 5) {
047            throw new ClassGenException("ICONST can be used only for value between -1 and 5: " + i);
048        }
049        super.setOpcode((short) (org.apache.bcel.Const.ICONST_0 + i)); // Even works for i == -1
050        value = i;
051    }
052
053    /**
054     * Call corresponding visitor method(s). The order is: Call visitor methods of implemented interfaces first, then call
055     * methods according to the class hierarchy in descending order, that is, the most specific visitXXX() call comes last.
056     *
057     * @param v Visitor object.
058     */
059    @Override
060    public void accept(final Visitor v) {
061        v.visitPushInstruction(this);
062        v.visitStackProducer(this);
063        v.visitTypedInstruction(this);
064        v.visitConstantPushInstruction(this);
065        v.visitICONST(this);
066    }
067
068    /**
069     * @return Type.INT.
070     */
071    @Override
072    public Type getType(final ConstantPoolGen cp) {
073        return Type.INT;
074    }
075
076    @Override
077    public Number getValue() {
078        return Integer.valueOf(value);
079    }
080}