Web Site

org.codehaus.janino.util
Class ClassFile

java.lang.Object
  extended by org.codehaus.janino.util.ClassFile

public class ClassFile
extends java.lang.Object

An object that represents the JavaTM "class file" format.

ClassFile(InputStream) creates a ClassFile object from the bytecode read from the given InputStream.

store(OutputStream) generates JavaTM bytecode which is suitable for being processed by a JavaTM virtual machine.


Nested Class Summary
static class ClassFile.AttributeInfo
          Representation of a class file attribute (see JVMS 4.7).
static class ClassFile.ConstantClassInfo
           
static class ClassFile.ConstantFieldrefInfo
           
static class ClassFile.ConstantInterfaceMethodrefInfo
           
static class ClassFile.ConstantMethodrefInfo
           
static class ClassFile.ConstantNameAndTypeInfo
           
static class ClassFile.ConstantPoolInfo
           
static class ClassFile.ConstantUtf8Info
           
static class ClassFile.ConstantValueAttribute
          Representation of a "ConstantValue" attribute (see JVMS 4.7.2).
static class ClassFile.ConstantValuePoolInfo
           
static class ClassFile.DeprecatedAttribute
          Representation of a "Deprecated" attribute (see JVMS 4.7.10).
static class ClassFile.ExceptionsAttribute
          Representation of an "Exceptions" attribute (see JVMS 4.7.4).
static class ClassFile.FieldInfo
           
static class ClassFile.InnerClassesAttribute
          Representation of an "InnerClasses" attribute (see JVMS 4.7.5).
static class ClassFile.LineNumberTableAttribute
          Representation of a "LineNumberTable" attribute (see JVMS 4.7.8).
static class ClassFile.LocalVariableTableAttribute
          Representation of a "LocalVariableTable" attribute (see JVMS 4.7.9).
 class ClassFile.MethodInfo
          This class represents a "method_info" structure, as defined by the JVM specification.
static class ClassFile.SourceFileAttribute
          Representation of a "SourceFile" attribute (see JVMS 4.7.7).
static class ClassFile.SyntheticAttribute
          Representation of a "Synthetic" attribute (see JVMS 4.7.6).
 
Field Summary
 short accessFlags
           
 java.util.List constantPool
           
 java.util.List fieldInfos
           
 short[] interfaces
           
static short MAJOR_VERSION_JDK_1_1
           
static short MAJOR_VERSION_JDK_1_2
           
static short MAJOR_VERSION_JDK_1_3
           
static short MAJOR_VERSION_JDK_1_4
           
static short MAJOR_VERSION_JDK_1_5
           
 java.util.List methodInfos
           
static short MINOR_VERSION_JDK_1_1
           
static short MINOR_VERSION_JDK_1_2
           
static short MINOR_VERSION_JDK_1_3
           
static short MINOR_VERSION_JDK_1_4
           
static short MINOR_VERSION_JDK_1_5
           
 short superclass
           
 short thisClass
           
 
Constructor Summary
ClassFile(java.io.InputStream inputStream)
          Read "class file" data from a InputStream and construct a ClassFile object from it.
ClassFile(short accessFlags, java.lang.String thisClassFD, java.lang.String superclassFD, java.lang.String[] interfaceFDs)
          Construct from parsed components.
 
Method Summary
 short addConstantClassInfo(java.lang.String typeFD)
          Add a "CONSTANT_Class_info" structure to the class file.
 short addConstantDoubleInfo(double value)
          Add a "CONSTANT_Double_info" structure to the class file.
 short addConstantFieldrefInfo(java.lang.String classFD, java.lang.String fieldName, java.lang.String fieldFD)
          Add a "CONSTANT_Fieldref_info" structure to the class file.
 short addConstantFloatInfo(float value)
          Add a "CONSTANT_Float_info" structure to the class file.
 short addConstantIntegerInfo(int value)
          Add a "CONSTANT_Integer_info" structure to the class file.
 short addConstantInterfaceMethodrefInfo(java.lang.String classFD, java.lang.String methodName, java.lang.String methodMD)
          Add a "CONSTANT_InterfaceMethodref_info" structure to the class file.
 short addConstantLongInfo(long value)
          Add a "CONSTANT_Long_info" structure to the class file.
 short addConstantMethodrefInfo(java.lang.String classFD, java.lang.String methodName, java.lang.String methodMD)
          Add a "CONSTANT_Methodref_info" structure to the class file.
 short addConstantStringInfo(java.lang.String string)
          Add a "CONSTANT_String_info" structure to the class file.
 short addConstantUtf8Info(java.lang.String s)
          Add a "CONSTANT_Utf8_info" structure to the class file.
 void addDeprecatedAttribute()
           
 ClassFile.FieldInfo addFieldInfo(short accessFlags, java.lang.String fieldName, java.lang.String fieldTypeFD, java.lang.Object optionalConstantValue)
           
 void addInnerClassesAttributeEntry(ClassFile.InnerClassesAttribute.Entry e)
          Create an "InnerClasses" attribute if it does not exist, then add the given entry to the "InnerClasses" attribute.
 ClassFile.MethodInfo addMethodInfo(short accessFlags, java.lang.String methodName, java.lang.String methodMD)
           
 void addSourceFileAttribute(java.lang.String sourceFileName)
          Adds a "SourceFile" attribute to this class file.
static java.lang.String getClassFileResourceName(java.lang.String className)
          Construct the name of a resource that could contain the class file of the class with the given name.
 java.lang.String getConstantClassName(short index)
           
 ClassFile.ConstantPoolInfo getConstantPoolInfo(short index)
           
 java.lang.String getConstantUtf8(short index)
           
 ClassFile.InnerClassesAttribute getInnerClassesAttribute()
          Find the "InnerClasses" attribute of this class file
 short getMajorVersion()
          Returns the current major class file version number.
 short getMinorVersion()
          Returns the current minor class file version number.
static java.lang.String getSourceResourceName(java.lang.String className)
          Construct the name of a resource that could contain the source code of the class with the given name.
 java.lang.String getThisClassName()
           
static boolean isRecognizedVersion(short majorVersion, short minorVersion)
           
 void setVersion(short majorVersion, short minorVersion)
          Sets the major and minor class file version numbers (JVMS 4.1).
 void store(java.io.OutputStream os)
          Write ClassFile to an OutputStream, in "class file" format.
 byte[] toByteArray()
          Return the byte code of this ClassFile as a byte array.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MAJOR_VERSION_JDK_1_1

public static final short MAJOR_VERSION_JDK_1_1
See Also:
Constant Field Values

MINOR_VERSION_JDK_1_1

public static final short MINOR_VERSION_JDK_1_1
See Also:
Constant Field Values

MAJOR_VERSION_JDK_1_2

public static final short MAJOR_VERSION_JDK_1_2
See Also:
Constant Field Values

MINOR_VERSION_JDK_1_2

public static final short MINOR_VERSION_JDK_1_2
See Also:
Constant Field Values

MAJOR_VERSION_JDK_1_3

public static final short MAJOR_VERSION_JDK_1_3
See Also:
Constant Field Values

MINOR_VERSION_JDK_1_3

public static final short MINOR_VERSION_JDK_1_3
See Also:
Constant Field Values

MAJOR_VERSION_JDK_1_4

public static final short MAJOR_VERSION_JDK_1_4
See Also:
Constant Field Values

MINOR_VERSION_JDK_1_4

public static final short MINOR_VERSION_JDK_1_4
See Also:
Constant Field Values

MAJOR_VERSION_JDK_1_5

public static final short MAJOR_VERSION_JDK_1_5
See Also:
Constant Field Values

MINOR_VERSION_JDK_1_5

public static final short MINOR_VERSION_JDK_1_5
See Also:
Constant Field Values

constantPool

public java.util.List constantPool

accessFlags

public short accessFlags

thisClass

public short thisClass

superclass

public short superclass

interfaces

public short[] interfaces

fieldInfos

public java.util.List fieldInfos

methodInfos

public java.util.List methodInfos
Constructor Detail

ClassFile

public ClassFile(short accessFlags,
                 java.lang.String thisClassFD,
                 java.lang.String superclassFD,
                 java.lang.String[] interfaceFDs)
Construct from parsed components.

Parameters:
accessFlags - as defined by Mod
thisClassFD - the field descriptor for this class
superclassFD - the field descriptor for the extended class (e.g. "Ljava/lang/Object;")
interfaceFDs - the field descriptors for the implemented interfaces

ClassFile

public ClassFile(java.io.InputStream inputStream)
          throws java.io.IOException,
                 java.lang.ClassFormatError
Read "class file" data from a InputStream and construct a ClassFile object from it.

If the ClassFile is created with this constructor, then most modifying operations lead to a UnsupportedOperationException; only fields, methods and attributes can be added.

Parameters:
inputStream -
Throws:
java.io.IOException
java.lang.ClassFormatError
Method Detail

addSourceFileAttribute

public void addSourceFileAttribute(java.lang.String sourceFileName)
Adds a "SourceFile" attribute to this class file. (Does not check whether one exists already.)

Parameters:
sourceFileName -

addDeprecatedAttribute

public void addDeprecatedAttribute()

getInnerClassesAttribute

public ClassFile.InnerClassesAttribute getInnerClassesAttribute()
Find the "InnerClasses" attribute of this class file

Returns:
null if this class has no "InnerClasses" attribute

addInnerClassesAttributeEntry

public void addInnerClassesAttributeEntry(ClassFile.InnerClassesAttribute.Entry e)
Create an "InnerClasses" attribute if it does not exist, then add the given entry to the "InnerClasses" attribute.

Parameters:
e -

getThisClassName

public java.lang.String getThisClassName()
Returns:
The fully qualified name of this class, e.g. "pkg1.pkg2.Outer$Inner"

setVersion

public void setVersion(short majorVersion,
                       short minorVersion)
Sets the major and minor class file version numbers (JVMS 4.1). The class file version defaults to the JDK 1.1 values (45.3) which execute on virtually every JVM.

Parameters:
majorVersion -
minorVersion -

getMajorVersion

public short getMajorVersion()
Returns the current major class file version number.


getMinorVersion

public short getMinorVersion()
Returns the current minor class file version number.


isRecognizedVersion

public static boolean isRecognizedVersion(short majorVersion,
                                          short minorVersion)

addConstantClassInfo

public short addConstantClassInfo(java.lang.String typeFD)
Add a "CONSTANT_Class_info" structure to the class file.

See Also:
JVM specification, section 4.4.1

addConstantFieldrefInfo

public short addConstantFieldrefInfo(java.lang.String classFD,
                                     java.lang.String fieldName,
                                     java.lang.String fieldFD)
Add a "CONSTANT_Fieldref_info" structure to the class file.

See Also:
JVM specification, section 4.4.2

addConstantMethodrefInfo

public short addConstantMethodrefInfo(java.lang.String classFD,
                                      java.lang.String methodName,
                                      java.lang.String methodMD)
Add a "CONSTANT_Methodref_info" structure to the class file.

See Also:
JVM specification, section 4.4.2

addConstantInterfaceMethodrefInfo

public short addConstantInterfaceMethodrefInfo(java.lang.String classFD,
                                               java.lang.String methodName,
                                               java.lang.String methodMD)
Add a "CONSTANT_InterfaceMethodref_info" structure to the class file.

See Also:
JVM specification, section 4.4.2

addConstantStringInfo

public short addConstantStringInfo(java.lang.String string)
Add a "CONSTANT_String_info" structure to the class file.

See Also:
JVM specification, section 4.4.3

addConstantIntegerInfo

public short addConstantIntegerInfo(int value)
Add a "CONSTANT_Integer_info" structure to the class file.

See Also:
JVM specification, section 4.4.4

addConstantFloatInfo

public short addConstantFloatInfo(float value)
Add a "CONSTANT_Float_info" structure to the class file.

See Also:
JVM specification, section 4.4.4

addConstantLongInfo

public short addConstantLongInfo(long value)
Add a "CONSTANT_Long_info" structure to the class file.

See Also:
JVM specification, section 4.4.5

addConstantDoubleInfo

public short addConstantDoubleInfo(double value)
Add a "CONSTANT_Double_info" structure to the class file.

See Also:
JVM specification, section 4.4.5

addConstantUtf8Info

public short addConstantUtf8Info(java.lang.String s)
Add a "CONSTANT_Utf8_info" structure to the class file.

See Also:
JVM specification, section 4.4.7

addFieldInfo

public ClassFile.FieldInfo addFieldInfo(short accessFlags,
                                        java.lang.String fieldName,
                                        java.lang.String fieldTypeFD,
                                        java.lang.Object optionalConstantValue)

addMethodInfo

public ClassFile.MethodInfo addMethodInfo(short accessFlags,
                                          java.lang.String methodName,
                                          java.lang.String methodMD)

getConstantPoolInfo

public ClassFile.ConstantPoolInfo getConstantPoolInfo(short index)

getConstantClassName

public java.lang.String getConstantClassName(short index)
Parameters:
index - Index to a CONSTANT_Class_info in the constant pool
Returns:
The name of the denoted class in "internal form" (see JVMS 4.2)

getConstantUtf8

public java.lang.String getConstantUtf8(short index)
Parameters:
index - Index to a CONSTANT_Utf8_info in the constant pool
Returns:
The string represented by the structure

store

public void store(java.io.OutputStream os)
           throws java.io.IOException
Write ClassFile to an OutputStream, in "class file" format.

Notice that if an IOException is thrown, the class file is probably written incompletely and thus invalid. The calling method must take care of this situation, e.g. by closing the output stream and then deleting the file.

Parameters:
os -
Throws:
java.io.IOException

getSourceResourceName

public static java.lang.String getSourceResourceName(java.lang.String className)
Construct the name of a resource that could contain the source code of the class with the given name.

Notice that member types are declared inside a different type, so the relevant source file is that of the outermost declaring class.

Parameters:
className - Fully qualified class name, e.g. "pkg1.pkg2.Outer$Inner"
Returns:
the name of the resource, e.g. "pkg1/pkg2/Outer.java"

getClassFileResourceName

public static java.lang.String getClassFileResourceName(java.lang.String className)
Construct the name of a resource that could contain the class file of the class with the given name.

Parameters:
className - Fully qualified class name, e.g. "pkg1.pkg2.Outer$Inner"
Returns:
the name of the resource, e.g. "pkg1/pkg2/Outer$Inner.class"

toByteArray

public byte[] toByteArray()
Return the byte code of this ClassFile as a byte array.


Web Site