/*
 * reserved comment block
 * DO NOT REMOVE OR ALTER!
 */
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.sun.org.apache.bcel.internal.classfile;


import  com.sun.org.apache.bcel.internal.Constants;
import  java.io.*;

This class represents a inner class attribute, i.e., the class
indices of the inner and outer classes, the name and the attributes
of the inner class.
Author:
 M. Dahm
See Also:
InnerClasses/**
 * This class represents a inner class attribute, i.e., the class
 * indices of the inner and outer classes, the name and the attributes
 * of the inner class.
 *
 * @author  <A HREF="mailto:markus.dahm@berlin.de">M. Dahm</A>
 * @see InnerClasses
 */
public final class InnerClass implements Cloneable, Node {
  private int inner_class_index;
  private int outer_class_index;
  private int inner_name_index;
  private int inner_access_flags;

  
Initialize from another object.
/**
   * Initialize from another object.
   */
  public InnerClass(InnerClass c) {
    this(c.getInnerClassIndex(), c.getOuterClassIndex(), c.getInnerNameIndex(),
         c.getInnerAccessFlags());
  }

  
Construct object from file stream.
Params:
file – Input stream
Throws:
IOException – /**
   * Construct object from file stream.
   * @param file Input stream
   * @throws IOException
   */
  InnerClass(DataInputStream file) throws IOException
  {
    this(file.readUnsignedShort(), file.readUnsignedShort(),
         file.readUnsignedShort(), file.readUnsignedShort());
  }

  
Params:
inner_class_index – Class index in constant pool of inner class
outer_class_index – Class index in constant pool of outer class
inner_name_index –  Name index in constant pool of inner class
inner_access_flags – Access flags of inner class/**
   * @param inner_class_index Class index in constant pool of inner class
   * @param outer_class_index Class index in constant pool of outer class
   * @param inner_name_index  Name index in constant pool of inner class
   * @param inner_access_flags Access flags of inner class
   */
  public InnerClass(int inner_class_index, int outer_class_index,
                    int inner_name_index, int inner_access_flags)
  {
    this.inner_class_index  = inner_class_index;
    this.outer_class_index  = outer_class_index;
    this.inner_name_index   = inner_name_index;
    this.inner_access_flags = inner_access_flags;
  }

  
Called by objects that are traversing the nodes of the tree implicitely
defined by the contents of a Java class. I.e., the hierarchy of methods,
fields, attributes, etc. spawns a tree of objects.
Params:
v – Visitor object/**
   * Called by objects that are traversing the nodes of the tree implicitely
   * defined by the contents of a Java class. I.e., the hierarchy of methods,
   * fields, attributes, etc. spawns a tree of objects.
   *
   * @param v Visitor object
   */
  public void accept(Visitor v) {
    v.visitInnerClass(this);
  }
  
Dump inner class attribute to file stream in binary format.
Params:
file – Output file stream
Throws:
IOException – /**
   * Dump inner class attribute to file stream in binary format.
   *
   * @param file Output file stream
   * @throws IOException
   */
  public final void dump(DataOutputStream file) throws IOException
  {
    file.writeShort(inner_class_index);
    file.writeShort(outer_class_index);
    file.writeShort(inner_name_index);
    file.writeShort(inner_access_flags);
  }
  
Returns:
access flags of inner class./**
   * @return access flags of inner class.
   */
  public final int getInnerAccessFlags() { return inner_access_flags; }
  
Returns:
class index of inner class./**
   * @return class index of inner class.
   */
  public final int getInnerClassIndex() { return inner_class_index; }
  
Returns:
name index of inner class./**
   * @return name index of inner class.
   */
  public final int getInnerNameIndex() { return inner_name_index; }
  
Returns:
class index of outer class./**
   * @return class index of outer class.
   */
  public final int getOuterClassIndex() { return outer_class_index; }
  
@param
inner_access_flags./**
   * @param inner_access_flags.
   */
  public final void setInnerAccessFlags(int inner_access_flags) {
    this.inner_access_flags = inner_access_flags;
  }
  
@param
inner_class_index./**
   * @param inner_class_index.
   */
  public final void setInnerClassIndex(int inner_class_index) {
    this.inner_class_index = inner_class_index;
  }
  
@param
inner_name_index./**
   * @param inner_name_index.
   */
  public final void setInnerNameIndex(int inner_name_index) {
    this.inner_name_index = inner_name_index;
  }
  
@param
outer_class_index./**
   * @param outer_class_index.
   */
  public final void setOuterClassIndex(int outer_class_index) {
    this.outer_class_index = outer_class_index;
  }
  
Returns:
String representation./**
   * @return String representation.
   */
  public final String toString() {
    return "InnerClass(" + inner_class_index + ", " + outer_class_index +
      ", " + inner_name_index + ", " + inner_access_flags + ")";
  }

  
Returns:
Resolved string representation/**
   * @return Resolved string representation
   */
  public final String toString(ConstantPool constant_pool) {
    String inner_class_name, outer_class_name, inner_name, access;

    inner_class_name = constant_pool.getConstantString(inner_class_index,
                                                       Constants.CONSTANT_Class);
    inner_class_name = Utility.compactClassName(inner_class_name);

    if (outer_class_index != 0) {
      outer_class_name = constant_pool.getConstantString(outer_class_index,
                                                         Constants.CONSTANT_Class);
      outer_class_name = Utility.compactClassName(outer_class_name);
    }
    else
      outer_class_name = "<not a member>";

    if(inner_name_index != 0)
      inner_name = ((ConstantUtf8)constant_pool.
                    getConstant(inner_name_index, Constants.CONSTANT_Utf8)).getBytes();
    else
      inner_name = "<anonymous>";

    access = Utility.accessToString(inner_access_flags, true);
    access = access.equals("")? "" : (access + " ");

    return "InnerClass:" + access + inner_class_name +
      "(\"" + outer_class_name + "\", \"" + inner_name + "\")";
  }

  
Returns:
deep copy of this object/**
   * @return deep copy of this object
   */
  public InnerClass copy() {
    try {
      return (InnerClass)clone();
    } catch(CloneNotSupportedException e) {}

    return null;
  }
}