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
019import java.io.DataOutputStream;
020import java.io.IOException;
021
022import org.apache.bcel.ExceptionConst;
023import org.apache.bcel.util.ByteSequence;
024
025/**
026 * NEWARRAY - Create new array of basic type (int, short, ...)
027 *
028 * <PRE>
029 * Stack: ..., count -&gt; ..., arrayref
030 * </PRE>
031 *
032 * type must be one of T_INT, T_SHORT, ...
033 */
034public class NEWARRAY extends Instruction implements AllocationInstruction, ExceptionThrower, StackProducer {
035
036    private byte type;
037
038    /**
039     * Empty constructor needed for Instruction.readInstruction. Not to be used otherwise.
040     */
041    NEWARRAY() {
042    }
043
044    public NEWARRAY(final BasicType type) {
045        this(type.getType());
046    }
047
048    public NEWARRAY(final byte type) {
049        super(org.apache.bcel.Const.NEWARRAY, (short) 2);
050        this.type = type;
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, i.e., 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.visitAllocationInstruction(this);
062        v.visitExceptionThrower(this);
063        v.visitStackProducer(this);
064        v.visitNEWARRAY(this);
065    }
066
067    /**
068     * Dump instruction as byte code to stream out.
069     *
070     * @param out Output stream
071     */
072    @Override
073    public void dump(final DataOutputStream out) throws IOException {
074        out.writeByte(super.getOpcode());
075        out.writeByte(type);
076    }
077
078    @Override
079    public Class<?>[] getExceptions() {
080        return new Class[] {ExceptionConst.NEGATIVE_ARRAY_SIZE_EXCEPTION};
081    }
082
083    /**
084     * @return type of constructed array
085     */
086    public final Type getType() {
087        return new ArrayType(BasicType.getType(type), 1);
088    }
089
090    /**
091     * @return numeric code for basic element type
092     */
093    public final byte getTypecode() {
094        return type;
095    }
096
097    /**
098     * Read needed data (e.g. index) from file.
099     */
100    @Override
101    protected void initFromFile(final ByteSequence bytes, final boolean wide) throws IOException {
102        type = bytes.readByte();
103        super.setLength(2);
104    }
105
106    /**
107     * @return mnemonic for instruction
108     */
109    @Override
110    public String toString(final boolean verbose) {
111        return super.toString(verbose) + " " + org.apache.bcel.Const.getTypeName(type);
112    }
113}