/*
 * 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 java.io.DataInput;
import java.io.DataOutputStream;
import java.io.IOException;

import com.sun.org.apache.bcel.internal.Const;

This class is derived from Attribute and records the nest host of the nest
to which the current class or interface claims to belong.
There may be at most one NestHost attribute in a ClassFile structure.
See Also:
Attribute/**
 * This class is derived from <em>Attribute</em> and records the nest host of the nest
 * to which the current class or interface claims to belong.
 * There may be at most one NestHost attribute in a ClassFile structure.
 *
 * @see     Attribute
 */
public final class NestHost extends Attribute {

    private int host_class_index;


    
Initializes from another object. Note that both objects use the same
references (shallow copy). Use copy() for a physical copy.
/**
     * Initializes from another object. Note that both objects use the same
     * references (shallow copy). Use copy() for a physical copy.
     */
    public NestHost(final NestHost c) {
        this(c.getNameIndex(), c.getLength(), c.getHostClassIndex(), c.getConstantPool());
    }


    
Params:
name_index – Index in constant pool
length – Content length in bytes
host_class_index – Host class index
constant_pool – Array of constants/**
     * @param name_index Index in constant pool
     * @param length Content length in bytes
     * @param host_class_index Host class index
     * @param constant_pool Array of constants
     */
    public NestHost(final int name_index, final int length, final int host_class_index,
            final ConstantPool constant_pool) {
        super(Const.ATTR_NEST_MEMBERS, name_index, length, constant_pool);
        this.host_class_index = host_class_index;
    }


    
Constructs object from input stream.
Params:
name_index – Index in constant pool
length – Content length in bytes
input – Input stream
constant_pool – Array of constants
Throws:
IOException – /**
     * Constructs object from input stream.
     * @param name_index Index in constant pool
     * @param length Content length in bytes
     * @param input Input stream
     * @param constant_pool Array of constants
     * @throws IOException
     */
    NestHost(final int name_index, final int length, final DataInput input, final ConstantPool constant_pool) throws IOException {
        this(name_index, length, 0, constant_pool);
        host_class_index = input.readUnsignedShort();
    }


    
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
     */
    @Override
    public void accept( final Visitor v ) {
        v.visitNestHost(this);
    }


    
Dumps NestHost attribute to file stream in binary format.
Params:
file – Output file stream
Throws:
IOException – if an I/O error occurs./**
     * Dumps NestHost attribute to file stream in binary format.
     *
     * @param file Output file stream
     * @throws IOException if an I/O error occurs.
     */
    @Override
    public void dump( final DataOutputStream file ) throws IOException {
        super.dump(file);
        file.writeShort(host_class_index);
    }


    
Returns:
index into constant pool of host class name./**
     * @return index into constant pool of host class name.
     */
    public int getHostClassIndex() {
        return host_class_index;
    }


    
Params:
host_class_index – the host class index/**
     * @param host_class_index the host class index
     */
    public void setHostClassIndex( final int host_class_index ) {
        this.host_class_index = host_class_index;
    }


    
Returns:
String representation/**
     * @return String representation
     */
    @Override
    public String toString() {
        final StringBuilder buf = new StringBuilder();
        buf.append("NestHost: ");
        final String class_name = super.getConstantPool().getConstantString(host_class_index, Const.CONSTANT_Class);
        buf.append(Utility.compactClassName(class_name, false));
        return buf.toString();
    }


    
Returns:
deep copy of this attribute/**
     * @return deep copy of this attribute
     */
    @Override
    public Attribute copy( final ConstantPool _constant_pool ) {
        final NestHost c = (NestHost) clone();
        c.setConstantPool(_constant_pool);
        return c;
    }
}