ClassFile (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.expr.ClassFile

All Implemented Interfaces:

CompilerConstants, WritableData
```
public class ClassFile
extends java.lang.Object
implements WritableData, CompilerConstants
```
This class encapsulates knowledge about the Java class file format as defined in The Java Virtual Machine Specification, Second Edition by Tim Lindholm and Frank Yellin. It contains methods to store and retrieve data specific to a class file, and to write a binary class file to an output stream. The class file written is compliant with the JVM specification referenced above.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ACC_ABSTRACT` Abstract access flag.
`static int`	`ACC_FINAL` Final access flag.
`static int`	`ACC_INTERFACE` Interface access flag.
`static int`	`ACC_NATIVE` Native access flag.
`static int`	`ACC_PRIVATE` Private access flag.
`static int`	`ACC_PROTECTED` Protected access flag.
`static int`	`ACC_PUBLIC` Public access flag.
`static int`	`ACC_STATIC` Static access flag.
`static int`	`ACC_STRICT` Strict access flag.
`static int`	`ACC_SUPER` Super access flag.
`static int`	`ACC_SYNCHRONIZED` Synchronized access flag.
`static int`	`ACC_TRANSIENT` Transient access flag.
`static int`	`ACC_VOLATILE` Volatile access flag.
`private int`	`accessFlags` Bitwise or'ed access flags.
`private java.util.List`	`attrs` List of attributes associated with current class.
`private java.util.List`	`fields` List of fields contained within current class.
`private java.util.List`	`interfaces` List of interfaces implemented by current class.
`private static int`	`MAGIC_NUMBER` Magic number which is first four bytes of a valid class file
`private static int`	`MAJOR_VERSION` Major version expected by JVM.
`private java.util.List`	`methods` List of methods contained within current class.
`private static int`	`MINOR_VERSION` Minor version expected by JVM.
`static java.lang.String`	`OBJECT_CLASSNAME` Fully qualified name of the Object class.
`private ConstantPool`	`pool` Constant pool for this class.
`private ClassConstant`	`superClass` Class constant representing parent of class being compiled.
`private ClassConstant`	`thisClass` Class constant representing current class being compiled.

Fields inherited from interface com.goldencode.expr.CompilerConstants
_aastore, _aconst_null, _aload_0, _aload_1, _aload_2, _aload_3, _anewarray, _areturn, _astore_1, _astore_2, _astore_3, _checkcast, _d2i, _d2l, _dadd, _dcmpg, _dconst_0, _dconst_1, _ddiv, _dmul, _dneg, _drem, _dreturn, _dsub, _dup, _getfield, _getstatic, _goto, _i2d, _i2l, _iadd, _iand, _iconst_0, _iconst_1, _iconst_2, _iconst_3, _iconst_4, _iconst_5, _idiv, _if_icmpeq, _if_icmpge, _if_icmpgt, _if_icmple, _if_icmplt, _if_icmpne, _ifeq, _ifge, _ifgt, _ifle, _iflt, _ifne, _ifnonnull, _ifnull, _imul, _ineg, _invokeinterface, _invokespecial, _invokestatic, _invokevirtual, _ior, _irem, _ireturn, _ishl, _ishr, _isub, _iushr, _ixor, _l2d, _l2i, _ladd, _land, _lcmp, _lconst_0, _lconst_1, _ldc_w, _ldc2_w, _ldiv, _lmul, _lneg, _lor, _lrem, _lshl, _lshr, _lsub, _lushr, _lxor, _new, _pop, _pop2, _return, _swap, CLASS_COMPILEDEXPRESSION, METHDESC_EXECUTE, METHNAME_EXECUTE, METHOD_INIT

Constructor Summary

Constructors
Constructor and Description

ClassFile(java.lang.String className)
Constructor.

ClassFile(java.lang.String className, java.lang.String superName)
Constructor.

Constructors
Constructor and Description
`ClassFile(java.lang.String className)` Constructor.
`ClassFile(java.lang.String className, java.lang.String superName)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MethodInfo`	`addDefaultConstructor(int accessFlags, Compiler compiler)` This method adds a default constructor with the specified access flags.
`ClassConstant`	`addInterface(java.lang.String name)` Add an interface to the constant pool of the current class.
`void`	`addMethod(MethodInfo methodInfo)` Add a method to the current class file.
`ConstantPool`	`getConstantPool()` Get a reference to this class file's constant pool.
`java.lang.String`	`getFullyQualifiedName()` Return the fully qualified name of the current class, substituting `.` characters for `/` characters.
`ClassConstant`	`getSuperClass()` Return class constant object for the current class' parent.
`void`	`setAccessFlags(int accessFlags)` Set the access flags for this class file.
`void`	`write(java.io.DataOutput out)` Write the class file to a binary output stream in the format defined by the JVM specification.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ACC_PUBLIC
```
public static final int ACC_PUBLIC
```
    Public access flag.
    
    See Also:
    
    Constant Field Values
  - ACC_PRIVATE
```
public static final int ACC_PRIVATE
```
    Private access flag.
    
    See Also:
    
    Constant Field Values
  - ACC_PROTECTED
```
public static final int ACC_PROTECTED
```
    Protected access flag.
    
    See Also:
    
    Constant Field Values
  - ACC_STATIC
```
public static final int ACC_STATIC
```
    Static access flag.
    
    See Also:
    
    Constant Field Values
  - ACC_FINAL
```
public static final int ACC_FINAL
```
    Final access flag.
    
    See Also:
    
    Constant Field Values
  - ACC_SUPER
```
public static final int ACC_SUPER
```
    Super access flag.
    
    See Also:
    
    Constant Field Values
  - ACC_SYNCHRONIZED
```
public static final int ACC_SYNCHRONIZED
```
    Synchronized access flag.
    
    See Also:
    
    Constant Field Values
  - ACC_VOLATILE
```
public static final int ACC_VOLATILE
```
    Volatile access flag.
    
    See Also:
    
    Constant Field Values
  - ACC_TRANSIENT
```
public static final int ACC_TRANSIENT
```
    Transient access flag.
    
    See Also:
    
    Constant Field Values
  - ACC_NATIVE
```
public static final int ACC_NATIVE
```
    Native access flag.
    
    See Also:
    
    Constant Field Values
  - ACC_INTERFACE
```
public static final int ACC_INTERFACE
```
    Interface access flag.
    
    See Also:
    
    Constant Field Values
  - ACC_ABSTRACT
```
public static final int ACC_ABSTRACT
```
    Abstract access flag.
    
    See Also:
    
    Constant Field Values
  - ACC_STRICT
```
public static final int ACC_STRICT
```
    Strict access flag.
    
    See Also:
    
    Constant Field Values
  - OBJECT_CLASSNAME
```
public static final java.lang.String OBJECT_CLASSNAME
```
    Fully qualified name of the Object class.
    
    See Also:
    
    Constant Field Values
  - MAGIC_NUMBER
```
private static final int MAGIC_NUMBER
```
    Magic number which is first four bytes of a valid class file
    
    See Also:
    
    Constant Field Values
  - MINOR_VERSION
```
private static final int MINOR_VERSION
```
    Minor version expected by JVM.
    
    See Also:
    
    Constant Field Values
  - MAJOR_VERSION
```
private static final int MAJOR_VERSION
```
    Major version expected by JVM.
    
    See Also:
    
    Constant Field Values
  - pool
```
private ConstantPool pool
```
    Constant pool for this class.
  - accessFlags
```
private int accessFlags
```
    Bitwise or'ed access flags.
  - thisClass
```
private ClassConstant thisClass
```
    Class constant representing current class being compiled.
  - superClass
```
private ClassConstant superClass
```
    Class constant representing parent of class being compiled.
  - interfaces
```
private java.util.List interfaces
```
    List of interfaces implemented by current class.
  - fields
```
private java.util.List fields
```
    List of fields contained within current class.
  - methods
```
private java.util.List methods
```
    List of methods contained within current class.
  - attrs
```
private java.util.List attrs
```
    List of attributes associated with current class.
- Constructor Detail
  - ClassFile
```
public ClassFile(java.lang.String className)
```
    Constructor. Assumes java/lang/Object as superclass of class being compiled.
    
    Parameters:
    
    className - Fully qualified name of class to be compiled, in the form package_qualifier/class_name.
  - ClassFile
```
public ClassFile(java.lang.String className,
                 java.lang.String superName)
```
    Constructor. Creates class constants for current class and its parent class, and adds them to the constant pool.
    
    Parameters:
    
    className - Fully qualified name of class to be compiled, in the form package_qualifier/class_name.
    
    superName - Fully qualified name of superclass of class to be compiled, in the form package_qualifier/class_name.
- Method Detail
  - getConstantPool
```
public ConstantPool getConstantPool()
```
    Get a reference to this class file's constant pool.
    
    Returns:
    
    Constant pool for current class.
  - getSuperClass
```
public ClassConstant getSuperClass()
```
    Return class constant object for the current class' parent.
    
    Returns:
    
    Class constant representing superclass of current class.
  - getFullyQualifiedName
```
public java.lang.String getFullyQualifiedName()
```
    Return the fully qualified name of the current class, substituting . characters for / characters.
    
    Returns:
    
    Name of current class, qualified by package name.
  - addDefaultConstructor
```
public MethodInfo addDefaultConstructor(int accessFlags,
                                        Compiler compiler)
```
    This method adds a default constructor with the specified access flags. The constructor does nothing more than invoking the superclass' default constructor.
    
    Parameters:
    
    accessFlags - Access flags to assign to constructor.
    
    compiler - The compiler to use.
    
    Returns:
    
    MethodInfo object representing the constructor.
  - setAccessFlags
```
public void setAccessFlags(int accessFlags)
```
    Set the access flags for this class file.
    
    Parameters:
    
    accessFlags - Bitwise or'ed combination of access flags.
  - addInterface
```
public ClassConstant addInterface(java.lang.String name)
```
    Add an interface to the constant pool of the current class. The interface is represented in the constant pool as a class constant.
    
    Parameters:
    
    name - Fully qualified name of the interface to be added, in the form package_qualifier/interface_name.
    
    Returns:
    
    Class constant which represents the interface.
  - addMethod
```
public void addMethod(MethodInfo methodInfo)
```
    Add a method to the current class file.
    
    Parameters:
    
    methodInfo - Object which describes the method.
  - write
```
public void write(java.io.DataOutput out)
           throws java.io.IOException
```
    Write the class file to a binary output stream in the format defined by the JVM specification. The following items are written to the stream, in order:
    1. File header
    2. Constant pool
    3. Access flags
    4. Class information for this class and its parent
    5. Interfaces implemented, if any
    6. Fields, if any (currently none implemented)
    7. Methods, if any
    8. Class file level attributes, if any (currently none implemented)
    Specified by:
    
    write in interface WritableData
    
    Parameters:
    
    out - Data output stream.
    
    Throws:
    
    java.io.IOException - if any error writing to output stream.

Class ClassFile

Field Summary

Fields inherited from interface com.goldencode.expr.CompilerConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ACC_PUBLIC

ACC_PRIVATE

ACC_PROTECTED

ACC_STATIC

ACC_FINAL

ACC_SUPER

ACC_SYNCHRONIZED

ACC_VOLATILE

ACC_TRANSIENT

ACC_NATIVE

ACC_INTERFACE

ACC_ABSTRACT

ACC_STRICT

OBJECT_CLASSNAME

MAGIC_NUMBER

MINOR_VERSION

MAJOR_VERSION

pool

accessFlags

thisClass

superClass

interfaces

fields

methods

attrs

Constructor Detail

ClassFile

ClassFile

Method Detail

getConstantPool

getSuperClass

getFullyQualifiedName

addDefaultConstructor

setAccessFlags

addInterface

addMethod

write