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    public ICONST(final int i) {
040        super(org.apache.bcel.Const.ICONST_0, (short) 1);
041        if (i < -1 || i > 5) {
042            throw new ClassGenException("ICONST can be used only for value between -1 and 5: " + i);
043        }
044        super.setOpcode((short) (org.apache.bcel.Const.ICONST_0 + i)); // Even works for i == -1
045        value = i;
046    }
047
048    /**
049     * Call corresponding visitor method(s). The order is: Call visitor methods of implemented interfaces first, then call
050     * methods according to the class hierarchy in descending order, i.e., the most specific visitXXX() call comes last.
051     *
052     * @param v Visitor object
053     */
054    @Override
055    public void accept(final Visitor v) {
056        v.visitPushInstruction(this);
057        v.visitStackProducer(this);
058        v.visitTypedInstruction(this);
059        v.visitConstantPushInstruction(this);
060        v.visitICONST(this);
061    }
062
063    /**
064     * @return Type.INT
065     */
066    @Override
067    public Type getType(final ConstantPoolGen cp) {
068        return Type.INT;
069    }
070
071    @Override
072    public Number getValue() {
073        return Integer.valueOf(value);
074    }
075}