/*
 * 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 indicates the main class of a module. There may be at most one ModuleMainClass attribute in a ClassFile structure.
See Also:
  • Attribute
/** * This class is derived from <em>Attribute</em> and indicates the main class of a module. * There may be at most one ModuleMainClass attribute in a ClassFile structure. * * @see Attribute */
public final class ModuleMainClass extends Attribute { private int main_class_index;
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 ModuleMainClass(final ModuleMainClass c) { this(c.getNameIndex(), c.getLength(), c.getHostClassIndex(), c.getConstantPool()); }
Params:
  • name_index – Index in constant pool
  • length – Content length in bytes
  • main_class_index – Host class index
  • constant_pool – Array of constants
/** * @param name_index Index in constant pool * @param length Content length in bytes * @param main_class_index Host class index * @param constant_pool Array of constants */
public ModuleMainClass(final int name_index, final int length, final int main_class_index, final ConstantPool constant_pool) { super(Const.ATTR_NEST_MEMBERS, name_index, length, constant_pool); this.main_class_index = main_class_index; }
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:
/** * 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 */
ModuleMainClass(final int name_index, final int length, final DataInput input, final ConstantPool constant_pool) throws IOException { this(name_index, length, 0, constant_pool); main_class_index = input.readUnsignedShort(); }
Called by objects that are traversing the nodes of the tree implicitly 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 implicitly * 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.visitModuleMainClass(this); }
Dump ModuleMainClass attribute to file stream in binary format.
Params:
  • file – Output file stream
Throws:
/** * Dump ModuleMainClass 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(main_class_index); }
Returns:index into constant pool of host class name.
/** * @return index into constant pool of host class name. */
public int getHostClassIndex() { return main_class_index; }
Params:
  • main_class_index – the host class index
/** * @param main_class_index the host class index */
public void setHostClassIndex( final int main_class_index ) { this.main_class_index = main_class_index; }
Returns:String representation
/** * @return String representation */
@Override public String toString() { final StringBuilder buf = new StringBuilder(); buf.append("ModuleMainClass: "); final String class_name = super.getConstantPool().getConstantString(main_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 ModuleMainClass c = (ModuleMainClass) clone(); c.setConstantPool(_constant_pool); return c; } }