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 com.sun.org.apache.bcel.internal.Constants;
  61 
  62 /**
  63  * Denotes array type, such as int[][]
  64  *
  65  * @author  <A HREF="mailto:markus.dahm@berlin.de">M. Dahm</A>
  66  */
  67 public final class ArrayType extends ReferenceType {
  68   private int  dimensions;
  69   private Type basic_type;
  70 
  71   /**
  72    * Convenience constructor for array type, e.g. int[]
  73    *
  74    * @param type array type, e.g. T_INT
  75    */
  76   public ArrayType(byte type, int dimensions) {
  77     this(BasicType.getType(type), dimensions);
  78   }
  79 
  80   /**
  81    * Convenience constructor for reference array type, e.g. Object[]
  82    *
  83    * @param class_name complete name of class (java.lang.String, e.g.)
  84    */
  85   public ArrayType(String class_name, int dimensions) {
  86     this(new ObjectType(class_name), dimensions);
  87   }
  88 
  89   /**
  90    * Constructor for array of given type
  91    *
  92    * @param type type of array (may be an array itself)
  93    */
  94   public ArrayType(Type type, int dimensions) {
  95     super(Constants.T_ARRAY, "<dummy>");
  96 
  97     if((dimensions < 1) || (dimensions > Constants.MAX_BYTE))
  98       throw new ClassGenException("Invalid number of dimensions: " + dimensions);
  99 
 100     switch(type.getType()) {
 101     case Constants.T_ARRAY:
 102       ArrayType array = (ArrayType)type;
 103       this.dimensions = dimensions + array.dimensions;
 104       basic_type      = array.basic_type;
 105       break;
 106 
 107     case Constants.T_VOID:
 108       throw new ClassGenException("Invalid type: void[]");
 109 
 110     default: // Basic type or reference
 111       this.dimensions = dimensions;
 112       basic_type = type;
 113       break;
 114     }
 115 
 116     StringBuffer buf = new StringBuffer();
 117     for(int i=0; i < this.dimensions; i++)
 118       buf.append('[');
 119 
 120     buf.append(basic_type.getSignature());
 121 
 122     signature = buf.toString();
 123   }
 124 
 125   /**
 126    * @return basic type of array, i.e., for int[][][] the basic type is int
 127    */
 128   public Type getBasicType() {
 129     return basic_type;
 130   }
 131 
 132   /**
 133    * @return element type of array, i.e., for int[][][] the element type is int[][]
 134    */
 135   public Type getElementType() {
 136     if(dimensions == 1)
 137       return basic_type;
 138     else
 139       return new ArrayType(basic_type, dimensions - 1);
 140   }
 141 
 142   /** @return number of dimensions of array
 143    */
 144   public int getDimensions() { return dimensions; }
 145 
 146   /** @return a hash code value for the object.
 147    */
 148   public int hashCode() { return basic_type.hashCode() ^ dimensions; }
 149 
 150   /** @return true if both type objects refer to the same array type.
 151    */
 152   public boolean equals(Object type) {
 153     if(type instanceof ArrayType) {
 154       ArrayType array = (ArrayType)type;
 155       return (array.dimensions == dimensions) && array.basic_type.equals(basic_type);
 156     } else
 157       return false;
 158   }
 159 }