/*
 * 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 org.apache.bcel.classfile;

import java.io.DataInput;
import java.io.DataOutputStream;
import java.io.IOException;

import org.apache.bcel.Const;

This class is derived from Attribute and represents the list of packages that are exported or opened by the Module attribute.
There may be at most one ModulePackages attribute in a ClassFile structure.
See Also:
Attribute/**
 * This class is derived from <em>Attribute</em> and represents the list of packages that are exported or opened by the Module attribute.
 * There may be at most one ModulePackages attribute in a ClassFile structure.
 *
 * @see     Attribute
 */
public final class ModulePackages extends Attribute {

    private int[] package_index_table;


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


    
Params:
name_index – Index in constant pool
length – Content length in bytes
package_index_table – Table of indices in constant pool
constant_pool – Array of constants/**
     * @param name_index Index in constant pool
     * @param length Content length in bytes
     * @param package_index_table Table of indices in constant pool
     * @param constant_pool Array of constants
     */
    public ModulePackages(final int name_index, final int length, final int[] package_index_table,
            final ConstantPool constant_pool) {
        super(Const.ATTR_MODULE_PACKAGES, name_index, length, constant_pool);
        this.package_index_table = package_index_table != null ? package_index_table : new int[0];
    }


    
Construct 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 – /**
     * Construct 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
     */
    ModulePackages(final int name_index, final int length, final DataInput input, final ConstantPool constant_pool) throws IOException {
        this(name_index, length, (int[]) null, constant_pool);
        final int number_of_packages = input.readUnsignedShort();
        package_index_table = new int[number_of_packages];
        for (int i = 0; i < number_of_packages; i++) {
            package_index_table[i] = 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.visitModulePackages(this);
    }


    
Dump ModulePackages attribute to file stream in binary format.
Params:
file – Output file stream
Throws:
IOException – /**
     * Dump ModulePackages attribute to file stream in binary format.
     *
     * @param file Output file stream
     * @throws IOException
     */
    @Override
    public void dump( final DataOutputStream file ) throws IOException {
        super.dump(file);
        file.writeShort(package_index_table.length);
        for (final int index : package_index_table) {
            file.writeShort(index);
        }
    }


    
Returns:
array of indices into constant pool of package names./**
     * @return array of indices into constant pool of package names.
     */
    public int[] getPackageIndexTable() {
        return package_index_table;
    }


    
Returns:
Length of package table./**
     * @return Length of package table.
     */
    public int getNumberOfPackages() {
        return package_index_table == null ? 0 : package_index_table.length;
    }


    
Returns:
string array of package names/**
     * @return string array of package names
     */
    public String[] getPackageNames() {
        final String[] names = new String[package_index_table.length];
        for (int i = 0; i < package_index_table.length; i++) {
            names[i] = super.getConstantPool().getConstantString(package_index_table[i],
                    Const.CONSTANT_Package).replace('/', '.');
        }
        return names;
    }


    
Params:
package_index_table – the list of package indexes
Also redefines number_of_packages according to table length./**
     * @param package_index_table the list of package indexes
     * Also redefines number_of_packages according to table length.
     */
    public void setPackageIndexTable( final int[] package_index_table ) {
        this.package_index_table = package_index_table != null ? package_index_table : new int[0];
    }


    
Returns:
String representation, i.e., a list of packages./**
     * @return String representation, i.e., a list of packages.
     */
    @Override
    public String toString() {
        final StringBuilder buf = new StringBuilder();
        buf.append("ModulePackages(");
        buf.append(package_index_table.length);
        buf.append("):\n");
        for (final int index : package_index_table) {
            final String package_name = super.getConstantPool().getConstantString(index, Const.CONSTANT_Package);
            buf.append("  ").append(Utility.compactClassName(package_name, false)).append("\n");
        }
        return buf.substring(0, buf.length()-1); // remove the last newline
    }


    
Returns:
deep copy of this attribute/**
     * @return deep copy of this attribute
     */
    @Override
    public Attribute copy( final ConstantPool _constant_pool ) {
        final ModulePackages c = (ModulePackages) clone();
        if (package_index_table != null) {
            c.package_index_table = new int[package_index_table.length];
            System.arraycopy(package_index_table, 0, c.package_index_table, 0,
                    package_index_table.length);
        }
        c.setConstantPool(_constant_pool);
        return c;
    }
}