View Javadoc
1   /*
2    * reserved comment block
3    * DO NOT REMOVE OR ALTER!
4    */
5   package com.sun.org.apache.bcel.internal.generic;
6   
7   /* ====================================================================
8    * The Apache Software License, Version 1.1
9    *
10   * Copyright (c) 2001 The Apache Software Foundation.  All rights
11   * reserved.
12   *
13   * Redistribution and use in source and binary forms, with or without
14   * modification, are permitted provided that the following conditions
15   * are met:
16   *
17   * 1. Redistributions of source code must retain the above copyright
18   *    notice, this list of conditions and the following disclaimer.
19   *
20   * 2. Redistributions in binary form must reproduce the above copyright
21   *    notice, this list of conditions and the following disclaimer in
22   *    the documentation and/or other materials provided with the
23   *    distribution.
24   *
25   * 3. The end-user documentation included with the redistribution,
26   *    if any, must include the following acknowledgment:
27   *       "This product includes software developed by the
28   *        Apache Software Foundation (http://www.apache.org/)."
29   *    Alternately, this acknowledgment may appear in the software itself,
30   *    if and wherever such third-party acknowledgments normally appear.
31   *
32   * 4. The names "Apache" and "Apache Software Foundation" and
33   *    "Apache BCEL" must not be used to endorse or promote products
34   *    derived from this software without prior written permission. For
35   *    written permission, please contact apache@apache.org.
36   *
37   * 5. Products derived from this software may not be called "Apache",
38   *    "Apache BCEL", nor may "Apache" appear in their name, without
39   *    prior written permission of the Apache Software Foundation.
40   *
41   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
42   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
43   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
44   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
45   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
46   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
47   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
48   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
49   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
51   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52   * SUCH DAMAGE.
53   * ====================================================================
54   *
55   * This software consists of voluntary contributions made by many
56   * individuals on behalf of the Apache Software Foundation.  For more
57   * information on the Apache Software Foundation, please see
58   * <http://www.apache.org/>.
59   */
60  import java.io.*;
61  import com.sun.org.apache.bcel.internal.util.ByteSequence;
62  
63  /**
64   * NEWARRAY -  Create new array of basic type (int, short, ...)
65   * <PRE>Stack: ..., count -&gt; ..., arrayref</PRE>
66   * type must be one of T_INT, T_SHORT, ...
67   *
68   * @author  <A HREF="mailto:markus.dahm@berlin.de">M. Dahm</A>
69   */
70  public class NEWARRAY extends Instruction
71    implements AllocationInstruction, ExceptionThrower, StackProducer {
72    private byte type;
73  
74    /**
75     * Empty constructor needed for the Class.newInstance() statement in
76     * Instruction.readInstruction(). Not to be used otherwise.
77     */
78    NEWARRAY() {}
79  
80    public NEWARRAY(byte type) {
81      super(com.sun.org.apache.bcel.internal.Constants.NEWARRAY, (short)2);
82      this.type = type;
83    }
84  
85    public NEWARRAY(BasicType type) {
86        this(type.getType());
87    }
88  
89    /**
90     * Dump instruction as byte code to stream out.
91     * @param out Output stream
92     */
93    public void dump(DataOutputStream out) throws IOException {
94      out.writeByte(opcode);
95      out.writeByte(type);
96    }
97  
98    /**
99     * @return numeric code for basic element type
100    */
101   public final byte getTypecode() { return type; }
102 
103   /**
104    * @return type of constructed array
105    */
106   public final Type getType() {
107     return new ArrayType(BasicType.getType(type), 1);
108   }
109 
110   /**
111    * @return mnemonic for instruction
112    */
113   public String toString(boolean verbose) {
114     return super.toString(verbose) + " " + com.sun.org.apache.bcel.internal.Constants.TYPE_NAMES[type];
115   }
116   /**
117    * Read needed data (e.g. index) from file.
118    */
119   protected void initFromFile(ByteSequence bytes, boolean wide) throws IOException
120   {
121     type   = bytes.readByte();
122     length = 2;
123   }
124 
125   public Class[] getExceptions() {
126     return new Class[] { com.sun.org.apache.bcel.internal.ExceptionConstants.NEGATIVE_ARRAY_SIZE_EXCEPTION };
127   }
128 
129   /**
130    * Call corresponding visitor method(s). The order is:
131    * Call visitor methods of implemented interfaces first, then
132    * call methods according to the class hierarchy in descending order,
133    * i.e., the most specific visitXXX() call comes last.
134    *
135    * @param v Visitor object
136    */
137   public void accept(Visitor v) {
138     v.visitAllocationInstruction(this);
139     v.visitExceptionThrower(this);
140     v.visitStackProducer(this);
141     v.visitNEWARRAY(this);
142   }
143 }