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