Class ClassFile

java.lang.Object

org.codehaus.janino.util.ClassFile

All Implemented Interfaces:

Annotatable

public class ClassFile
extends Object
implements Annotatable

An object that implements the Java "class file" format.

ClassFile(InputStream) reads bytecode from an InputStream and creates a ClassFile object from it.

store(OutputStream) generates JVM bytecode which is suitable for being processed by a Java virtual machine, and writes it to an OutputStream.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClassFile.Annotation	The structure of the annotations array as described in JVMS8 4.7.16.
static class	ClassFile.AnnotationDefaultAttribute	Representation of an AnnotationDefault attribute (see JVMS8 4.7.22).
static class	ClassFile.AnnotationsAttribute	Representation of a Runtime[In]visibleAnnotations attribute (see JVMS8 4.7.16/17).
static final class	ClassFile.ArrayElementValue	Representation of the "array_value" structure.
static class	ClassFile.AttributeInfo	Representation of a class file attribute (see JVMS7 4.7).
static final class	ClassFile.BooleanElementValue
static final class	ClassFile.ByteElementValue
static final class	ClassFile.CharElementValue
static final class	ClassFile.ClassElementValue
static class	ClassFile.ClassFileException	Unchecked exception that represents an error condition that could occur during processing of class files, e.g.
static class	ClassFile.CodeAttribute	Representation of an unmodifiable Code attribute, as read from a class file.
static class	ClassFile.ConstantClassInfo	See JVMS7 4.4.1.
private static class	ClassFile.ConstantDoubleInfo	See JVMS7 4.4.5.
static class	ClassFile.ConstantElementValue	Convenience class for element values that are constants (as opposed to annotations, enum constants and arrays).
static class	ClassFile.ConstantFieldrefInfo	See JVMS7 4.4.2.
private static class	ClassFile.ConstantFloatInfo	See JVMS7 4.4.4.
private static class	ClassFile.ConstantIntegerInfo	See JVMS7 4.4.4.
static class	ClassFile.ConstantInterfaceMethodrefInfo	See JVMS7 4.4.2.
static class	ClassFile.ConstantInvokeDynamicInfo	See JVMS7 4.4.10.
private static class	ClassFile.ConstantLongInfo	See JVMS7 4.4.5.
static class	ClassFile.ConstantMethodHandleInfo	See JVMS7 4.4.8.
static class	ClassFile.ConstantMethodrefInfo	See JVMS7 4.4.2.
static class	ClassFile.ConstantMethodTypeInfo	See JVMS7 4.4.9.
static class	ClassFile.ConstantNameAndTypeInfo	See JVMS7 4.4.6.
static class	ClassFile.ConstantPoolInfo	Base for various the constant pool table entry types.
(package private) static class	ClassFile.ConstantStringInfo	See JVMS7 4.4.3.
static class	ClassFile.ConstantUtf8Info	See JVMS7 4.4.7.
static class	ClassFile.ConstantValueAttribute	Representation of a ConstantValue attribute (see JVMS 4.7.2).
static class	ClassFile.ConstantValuePoolInfo	Intermediate base class for constant pool table entry types that have 'value' semantics: Double, Float, Integer, Long, String
static class	ClassFile.DeprecatedAttribute	Representation of a Deprecated attribute (see JVMS 4.7.10).
static final class	ClassFile.DoubleElementValue
static interface	ClassFile.ElementValue	Representation of the "element_value" structure (see JVMS8 4.7.16.1).
static final class	ClassFile.EnumConstValue	Representation of the "enum_const_value" element in the "element_value" structure.
static class	ClassFile.ExceptionsAttribute	Representation of an Exceptions attribute (see JVMS 4.7.4).
class	ClassFile.FieldInfo	Representation of a "method_info" structure, as defined by JVMS7 4.5.
static final class	ClassFile.FloatElementValue
static class	ClassFile.InnerClassesAttribute	Representation of an InnerClasses attribute (see JVMS 4.7.5).
static final class	ClassFile.IntElementValue
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).
static final class	ClassFile.LongElementValue
class	ClassFile.MethodInfo	Representation of a "method_info" structure, as defined by JVMS7 4.6.
static final class	ClassFile.ShortElementValue
static class	ClassFile.SignatureAttribute	Representation of a Signature attribute (see JVMS 4.7.9).
static class	ClassFile.SourceFileAttribute	Representation of a SourceFile attribute (see JVMS 4.7.7).
static class	ClassFile.StackMapTableAttribute	Representation of an unmodifiable StackMapTable attribute, as read from a class file.
static final class	ClassFile.StringElementValue
static class	ClassFile.SyntheticAttribute	Representation of a Synthetic attribute (see JVMS 4.7.6).

Field Summary

Fields

Modifier and Type	Field	Description
final short	accessFlags	The access flags of the class.
private final List<ClassFile.AttributeInfo>	attributes	The ClassFile.AttributeInfos of the attributes of this class or interface.
private static final int	CLASS_FILE_MAGIC
private final List<ClassFile.ConstantPoolInfo>	constantPool
private final Map<ClassFile.ConstantPoolInfo, Short>	constantPoolMap
final List<ClassFile.FieldInfo>	fieldInfos	The ClassFile.FieldInfos of the field members of this class or interface.
final short[]	interfaces	The constant pool indexes of ClassFile.ConstantClassInfo which describe the interfaces that this class implements, resp.
static final short	MAJOR_VERSION_JDK_1_1	Major version number of a class file that was generated by a Java 1.1-compliant compiler.
static final short	MAJOR_VERSION_JDK_1_10	Major version number of a class file that was generated by a Java 1.10-compliant compiler.
static final short	MAJOR_VERSION_JDK_1_11	Major version number of a class file that was generated by a Java 1.11-compliant compiler.
static final short	MAJOR_VERSION_JDK_1_12	Major version number of a class file that was generated by a Java 1.12-compliant compiler.
static final short	MAJOR_VERSION_JDK_1_2	Major version number of a class file that was generated by a Java 1.2-compliant compiler.
static final short	MAJOR_VERSION_JDK_1_3	Major version number of a class file that was generated by a Java 1.3-compliant compiler.
static final short	MAJOR_VERSION_JDK_1_4	Major version number of a class file that was generated by a Java 1.4-compliant compiler.
static final short	MAJOR_VERSION_JDK_1_5	Major version number of a class file that was generated by a Java 1.5-compliant compiler.
static final short	MAJOR_VERSION_JDK_1_6	Major version number of a class file that was generated by a Java 1.6-compliant compiler.
static final short	MAJOR_VERSION_JDK_1_7	Major version number of a class file that was generated by a Java 1.7-compliant compiler.
static final short	MAJOR_VERSION_JDK_1_8	Major version number of a class file that was generated by a Java 1.8-compliant compiler.
static final short	MAJOR_VERSION_JDK_1_9	Major version number of a class file that was generated by a Java 1.9-compliant compiler.
private short	majorVersion
final List<ClassFile.MethodInfo>	methodInfos	The ClassFile.MethodInfos of the methods of this class or interface.
static final short	MINOR_VERSION_JDK_1_1	Minor version number of a class file that was generated by a Java 1.1-compliant compiler.
static final short	MINOR_VERSION_JDK_1_10	Minor version number of a class file that was generated by a Java 1.10-compliant compiler.
static final short	MINOR_VERSION_JDK_1_11	Minor version number of a class file that was generated by a Java 1.11-compliant compiler.
static final short	MINOR_VERSION_JDK_1_12	Minor version number of a class file that was generated by a Java 1.12-compliant compiler.
static final short	MINOR_VERSION_JDK_1_2	Minor version number of a class file that was generated by a Java 1.2-compliant compiler.
static final short	MINOR_VERSION_JDK_1_3	Minor version number of a class file that was generated by a Java 1.3-compliant compiler.
static final short	MINOR_VERSION_JDK_1_4	Minor version number of a class file that was generated by a Java 1.4-compliant compiler.
static final short	MINOR_VERSION_JDK_1_5	Minor version number of a class file that was generated by a Java 1.5-compliant compiler.
static final short	MINOR_VERSION_JDK_1_6	Minor version number of a class file that was generated by a Java 1.6-compliant compiler.
static final short	MINOR_VERSION_JDK_1_7	Minor version number of a class file that was generated by a Java 1.7-compliant compiler.
static final short	MINOR_VERSION_JDK_1_8	Minor version number of a class file that was generated by a Java 1.8-compliant compiler.
static final short	MINOR_VERSION_JDK_1_9	Minor version number of a class file that was generated by a Java 1.9-compliant compiler.
private short	minorVersion
final short	superclass	The constant pool index of the ClassFile.ConstantClassInfo that describes the superclass of this class.
final short	thisClass	The constant pool index of the ClassFile.ConstantClassInfo that describes this class.

Constructor Summary

Constructors

Constructor	Description
ClassFile(short accessFlags, String thisClassFd, String superclassFd, String[] interfaceFds)	Constructs a class with no fields and methods.
ClassFile(InputStream inputStream)	Reads "class file" data from the inputStream and construct a ClassFile object from it.

Method Summary

Modifier and Type	Method	Description
void	addAnnotationsAttributeEntry(boolean runtimeVisible, String fieldDescriptor, Map<Short, ClassFile.ElementValue> elementValuePairs)	Creates a Runtime[In]visibleAnnotations attribute on the class (if it does not yet exist) and adds an entry to it.
private void	addAnnotationsAttributeEntry(boolean runtimeVisible, String fieldDescriptor, Map<Short, ClassFile.ElementValue> elementValuePairs, List<ClassFile.AttributeInfo> target)	Adds a Runtime[In]visibleAnnotations attribute to the target (if it does not yet exist) and adds an entry to it.
short	addConstantClassInfo(String typeFd)	Returns the constant index number for a "CONSTANT_Class_info" structure to the class file.
short	addConstantDoubleInfo(double value)	Adds a "CONSTANT_Double_info" structure to the class file.
short	addConstantFieldrefInfo(String classFd, String fieldName, String fieldFd)	Adds a "CONSTANT_Fieldref_info" structure to the class file.
short	addConstantFloatInfo(float value)	Adds a "CONSTANT_Float_info" structure to the class file.
short	addConstantIntegerInfo(int value)	Adds a "CONSTANT_Integer_info" structure to the class file.
short	addConstantInterfaceMethodrefInfo(String classFd, String methodName, String methodMd)	Adds a "CONSTANT_InterfaceMethodref_info" structure to the class file.
short	addConstantLongInfo(long value)	Adds a "CONSTANT_Long_info" structure to the class file.
short	addConstantMethodrefInfo(String classFd, String methodName, String methodMd)	Adds a "CONSTANT_Methodref_info" structure to the class file.
private short	addConstantNameAndTypeInfo(String name, String descriptor)	Adds a "CONSTANT_NameAndType_info" structure to the class file.
private short	addConstantSifldInfo(Object cv)	Convenience method that adds a String, Integer, Float, Long or Double ConstantInfo.
short	addConstantStringInfo(String string)	Adds a "CONSTANT_String_info" structure to the class file.
short	addConstantUtf8Info(String s)	Adds a "CONSTANT_Utf8_info" structure to the class file if no equal entry exists.
void	addDeprecatedAttribute()	Adds the Deprecated attribute to this class.
ClassFile.FieldInfo	addFieldInfo(short accessFlags, String fieldName, String fieldTypeFd, Object constantValue)	Creates a ClassFile.FieldInfo and adds it to this class.
void	addInnerClassesAttributeEntry(ClassFile.InnerClassesAttribute.Entry entry)	Creates an InnerClasses attribute if it does not exist, then adds the entry to the InnerClasses attribute.
ClassFile.MethodInfo	addMethodInfo(short accessFlags, String methodName, MethodDescriptor methodMd)	Creates a ClassFile.MethodInfo and adds it to this class.
void	addSourceFileAttribute(String sourceFileName)	Adds a SourceFile attribute to this class file.
private short	addToConstantPool(ClassFile.ConstantPoolInfo cpi)	Adds an entry to the constant pool and returns its index, or, if an equal entry already exists in the constant pool, returns the index of that entry.
private ClassFile.AttributeInfo	findAttribute(List<ClassFile.AttributeInfo> attributes, String attributeName)	Finds the named attribute in the attributes.
ClassFile.Annotation[]	getAnnotations(boolean runtimeVisible)
private ClassFile.AnnotationsAttribute	getAnnotationsAttribute(boolean runtimeVisible, List<ClassFile.AttributeInfo> attributes)	Finds the Runtime[In]visibleAnnotations attribute in the attributes.
static String	getClassFileResourceName(String className)	Constructs the name of a resource that could contain the class file of the class with the className.
ClassFile.ConstantClassInfo	getConstantClassInfo(short index)
ClassFile.ConstantFieldrefInfo	getConstantFieldrefInfo(short index)
ClassFile.ConstantInterfaceMethodrefInfo	getConstantInterfaceMethodrefInfo(short index)
ClassFile.ConstantInvokeDynamicInfo	getConstantInvokeDynamicInfo(short index)
ClassFile.ConstantMethodHandleInfo	getConstantMethodHandleInfo(short index)
ClassFile.ConstantMethodrefInfo	getConstantMethodrefInfo(short index)
ClassFile.ConstantMethodTypeInfo	getConstantMethodTypeInfo(short index)
ClassFile.ConstantNameAndTypeInfo	getConstantNameAndTypeInfo(short index)
ClassFile.ConstantPoolInfo	getConstantPoolInfo(short index)
int	getConstantPoolSize()
String	getConstantUtf8(short index)	Shorthand for getConstantUtf8Info(index).s.
ClassFile.ConstantUtf8Info	getConstantUtf8Info(short index)
ClassFile.ConstantValuePoolInfo	getConstantValuePoolInfo(short index)
ClassFile.InnerClassesAttribute	getInnerClassesAttribute()	Finds the InnerClasses attribute of this class file.
short	getMajorVersion()
short	getMinorVersion()
ClassFile.SignatureAttribute	getSignatureAttribute()
static String	getSourceResourceName(String className)	Constructs the name of a resource that could contain the source code of the class with the className.
String	getThisClassName()
private ClassFile.AttributeInfo	loadAttribute(DataInputStream dis)	Loads one class file attribute.
private List<ClassFile.AttributeInfo>	loadAttributes(DataInputStream dis)	u2 attributes_count, attributes[attributes_count]
private void	loadConstantPool(DataInputStream dis)	u2 constant_pool_count, constant_pool[constant_pool_count]
private static ClassFile.ElementValue	loadElementValue(DataInputStream dis)
private List<ClassFile.FieldInfo>	loadFields(DataInputStream dis)	u2 fields_count, fields[fields_count]
private ClassFile.MethodInfo	loadMethodInfo(DataInputStream dis)
private List<ClassFile.MethodInfo>	loadMethods(DataInputStream dis)	u2 methods_count, methods[methods_count]
ClassFile.StackMapTableAttribute.ObjectVariableInfo	newObjectVariableInfo(String fieldDescriptor)
ClassFile.StackMapTableAttribute.UninitializedVariableInfo	newUninitializedVariableInfo(short offset)
private static byte[]	readLengthAndBytes(DataInputStream dis)	u4 length, u1[length]
private static short[]	readShortArray(DataInputStream dis)	u2 length, u2[length]
void	setVersion(short majorVersion, short minorVersion)	Sets the major and minor class file version numbers (JVMS 4.1).
void	store(OutputStream os)	Writes ClassFile to an OutputStream, in "class file" format.
private static void	storeAttributes(DataOutputStream dos, List<ClassFile.AttributeInfo> attributeInfos)	u2 attributes_count, attributes[attributes_count]
private static void	storeConstantPool(DataOutputStream dos, List<ClassFile.ConstantPoolInfo> constantPool)	u2 constant_pool_count, constant_pool[constant_pool_count - 1]
private static void	storeFields(DataOutputStream dos, List<ClassFile.FieldInfo> fieldInfos)	u2 fields_count, fields[fields_count]
private static void	storeMethods(DataOutputStream dos, List<ClassFile.MethodInfo> methodInfos)	u2 methods_count, methods[methods_count]
private static void	storeShortArray(DataOutputStream dos, short[] sa)	u2 count, u2[count]
byte[]	toByteArray()	Returns the byte code of this ClassFile as a byte array.
String	toString()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

CLASS_FILE_MAGIC

private static final int CLASS_FILE_MAGIC

See Also:

• Constant Field Values

MAJOR_VERSION_JDK_1_1

public static final short MAJOR_VERSION_JDK_1_1

Major version number of a class file that was generated by a Java 1.1-compliant compiler.

See Also:

• Constant Field Values

MINOR_VERSION_JDK_1_1

public static final short MINOR_VERSION_JDK_1_1

Minor version number of a class file that was generated by a Java 1.1-compliant compiler.

See Also:

• Constant Field Values

MAJOR_VERSION_JDK_1_2

public static final short MAJOR_VERSION_JDK_1_2

Major version number of a class file that was generated by a Java 1.2-compliant compiler.

See Also:

• Constant Field Values

MINOR_VERSION_JDK_1_2

public static final short MINOR_VERSION_JDK_1_2

Minor version number of a class file that was generated by a Java 1.2-compliant compiler.

See Also:

• Constant Field Values

MAJOR_VERSION_JDK_1_3

public static final short MAJOR_VERSION_JDK_1_3

Major version number of a class file that was generated by a Java 1.3-compliant compiler.

See Also:

• Constant Field Values

MINOR_VERSION_JDK_1_3

public static final short MINOR_VERSION_JDK_1_3

Minor version number of a class file that was generated by a Java 1.3-compliant compiler.

See Also:

• Constant Field Values

MAJOR_VERSION_JDK_1_4

public static final short MAJOR_VERSION_JDK_1_4

Major version number of a class file that was generated by a Java 1.4-compliant compiler.

See Also:

• Constant Field Values

MINOR_VERSION_JDK_1_4

public static final short MINOR_VERSION_JDK_1_4

Minor version number of a class file that was generated by a Java 1.4-compliant compiler.

See Also:

• Constant Field Values

MAJOR_VERSION_JDK_1_5

public static final short MAJOR_VERSION_JDK_1_5

Major version number of a class file that was generated by a Java 1.5-compliant compiler.

See Also:

• Constant Field Values

MINOR_VERSION_JDK_1_5

public static final short MINOR_VERSION_JDK_1_5

Minor version number of a class file that was generated by a Java 1.5-compliant compiler.

See Also:

• Constant Field Values

MAJOR_VERSION_JDK_1_6

public static final short MAJOR_VERSION_JDK_1_6

Major version number of a class file that was generated by a Java 1.6-compliant compiler.

See Also:

• Constant Field Values

MINOR_VERSION_JDK_1_6

public static final short MINOR_VERSION_JDK_1_6

Minor version number of a class file that was generated by a Java 1.6-compliant compiler.

See Also:

• Constant Field Values

MAJOR_VERSION_JDK_1_7

public static final short MAJOR_VERSION_JDK_1_7

Major version number of a class file that was generated by a Java 1.7-compliant compiler.

See Also:

• Constant Field Values

MINOR_VERSION_JDK_1_7

public static final short MINOR_VERSION_JDK_1_7

Minor version number of a class file that was generated by a Java 1.7-compliant compiler.

See Also:

• Constant Field Values

MAJOR_VERSION_JDK_1_8

public static final short MAJOR_VERSION_JDK_1_8

Major version number of a class file that was generated by a Java 1.8-compliant compiler.

See Also:

• Constant Field Values

MINOR_VERSION_JDK_1_8

public static final short MINOR_VERSION_JDK_1_8

Minor version number of a class file that was generated by a Java 1.8-compliant compiler.

See Also:

• Constant Field Values

MAJOR_VERSION_JDK_1_9

public static final short MAJOR_VERSION_JDK_1_9

Major version number of a class file that was generated by a Java 1.9-compliant compiler.

See Also:

• Constant Field Values

MINOR_VERSION_JDK_1_9

public static final short MINOR_VERSION_JDK_1_9

Minor version number of a class file that was generated by a Java 1.9-compliant compiler.

See Also:

• Constant Field Values

MAJOR_VERSION_JDK_1_10

public static final short MAJOR_VERSION_JDK_1_10

Major version number of a class file that was generated by a Java 1.10-compliant compiler.

See Also:

• Constant Field Values

MINOR_VERSION_JDK_1_10

public static final short MINOR_VERSION_JDK_1_10

Minor version number of a class file that was generated by a Java 1.10-compliant compiler.

See Also:

• Constant Field Values

MAJOR_VERSION_JDK_1_11

public static final short MAJOR_VERSION_JDK_1_11

Major version number of a class file that was generated by a Java 1.11-compliant compiler.

See Also:

• Constant Field Values

MINOR_VERSION_JDK_1_11

public static final short MINOR_VERSION_JDK_1_11

Minor version number of a class file that was generated by a Java 1.11-compliant compiler.

See Also:

• Constant Field Values

MAJOR_VERSION_JDK_1_12

public static final short MAJOR_VERSION_JDK_1_12

Major version number of a class file that was generated by a Java 1.12-compliant compiler.

See Also:

• Constant Field Values

MINOR_VERSION_JDK_1_12

public static final short MINOR_VERSION_JDK_1_12

Minor version number of a class file that was generated by a Java 1.12-compliant compiler.

See Also:

• Constant Field Values

majorVersion

private short majorVersion

minorVersion

private short minorVersion

constantPool

private final List<ClassFile.ConstantPoolInfo> constantPool

accessFlags

public final short accessFlags

The access flags of the class.

See Also:

• and consorts

thisClass

public final short thisClass

The constant pool index of the ClassFile.ConstantClassInfo that describes this class.

superclass

public final short superclass

The constant pool index of the ClassFile.ConstantClassInfo that describes the superclass of this class. Zero for class Object, Object for interfaces.

See Also:

• "JVMS11 4.1, The ClassFile Structure"

interfaces

public final short[] interfaces

The constant pool indexes of ClassFile.ConstantClassInfo which describe the interfaces that this class implements, resp. that this interface extends.

fieldInfos

public final List<ClassFile.FieldInfo> fieldInfos

The ClassFile.FieldInfos of the field members of this class or interface.

methodInfos

public final List<ClassFile.MethodInfo> methodInfos

The ClassFile.MethodInfos of the methods of this class or interface.

attributes

private final List<ClassFile.AttributeInfo> attributes

The ClassFile.AttributeInfos of the attributes of this class or interface.

constantPoolMap

private final Map<ClassFile.ConstantPoolInfo, Short> constantPoolMap

Constructor Details

ClassFile

public ClassFile(short accessFlags,
 String thisClassFd,
 @Nullable
 String superclassFd,
 String[] interfaceFds)

Constructs a class with no fields and methods. An application would typically add fields and methods before saving it.

By default, the .class file major and minor version are that of the currently executing JVM (system property "java.class.version").

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;"); null for Object

interfaceFds - The field descriptors for the implemented interfaces

See Also:

• setVersion(short, short)
• addFieldInfo(short, String, String, Object)
• addMethodInfo(short, String, MethodDescriptor)

ClassFile

public ClassFile(InputStream inputStream)
          throws IOException

Reads "class file" data from the 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.

Throws:

IOException

Method Details

addSourceFileAttribute

public void addSourceFileAttribute(String sourceFileName)

Adds a SourceFile attribute to this class file. (Does not check whether one exists already.)

Parameters:

sourceFileName -

addDeprecatedAttribute

public void addDeprecatedAttribute()

Adds the Deprecated attribute to this class.

getInnerClassesAttribute

@Nullable
public ClassFile.InnerClassesAttribute getInnerClassesAttribute()

Finds the InnerClasses attribute of this class file.

Returns:

null if this class has no "InnerClasses" attribute

getSignatureAttribute

@Nullable
public ClassFile.SignatureAttribute getSignatureAttribute()

findAttribute

@Nullable
private ClassFile.AttributeInfo findAttribute(List<ClassFile.AttributeInfo> attributes,
 String attributeName)
                                       throws ClassFormatError

Finds the named attribute in the attributes.

Returns:

null iff the attributes constain no attribute with that name

Throws:

ClassFile.ClassFileException - attributes contains more than one attribute with that name

ClassFormatError

addInnerClassesAttributeEntry

public void addInnerClassesAttributeEntry(ClassFile.InnerClassesAttribute.Entry entry)

Creates an InnerClasses attribute if it does not exist, then adds the entry to the InnerClasses attribute.

getAnnotationsAttribute

@Nullable
private ClassFile.AnnotationsAttribute getAnnotationsAttribute(boolean runtimeVisible,
 List<ClassFile.AttributeInfo> attributes)

Finds the Runtime[In]visibleAnnotations attribute in the attributes.

Returns:

null if attributes constains no such attribute

getAnnotations

public ClassFile.Annotation[] getAnnotations(boolean runtimeVisible)

Specified by:

getAnnotations in interface Annotatable

Returns:

The annotations on this element; an empty array iff there are no annotations

addAnnotationsAttributeEntry

public void addAnnotationsAttributeEntry(boolean runtimeVisible,
 String fieldDescriptor,
 Map<Short, ClassFile.ElementValue> elementValuePairs)

Creates a Runtime[In]visibleAnnotations attribute on the class (if it does not yet exist) and adds an entry to it.

Specified by:

addAnnotationsAttributeEntry in interface Annotatable

Parameters:

elementValuePairs - Maps element-name constant-pool-index (ClassFile.ConstantUtf8Info) to element value

addAnnotationsAttributeEntry

private void addAnnotationsAttributeEntry(boolean runtimeVisible,
 String fieldDescriptor,
 Map<Short, ClassFile.ElementValue> elementValuePairs,
 List<ClassFile.AttributeInfo> target)

Adds a Runtime[In]visibleAnnotations attribute to the target (if it does not yet exist) and adds an entry to it.

Parameters:

elementValuePairs - Maps "elemant_name_index" (ClassFile.ConstantUtf8Info) to "element_value", see JVMS8 4.7.16

getThisClassName

public 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).

ClassFile declares a set of valid major-minor version number pairs, e.g. MAJOR_VERSION_JDK_1_6 and MINOR_VERSION_JDK_1_6.

getMajorVersion

public short getMajorVersion()

Returns:

The current major class file version number

getMinorVersion

public short getMinorVersion()

Returns:

The current minor class file version number

addConstantClassInfo

public short addConstantClassInfo(String typeFd)

Returns the constant index number for a "CONSTANT_Class_info" structure to the class file. If the class hasn't been added before, adds it to the constant pool. Otherwise returns the constant number for that element of the pool.

See Also:

• JVM specification, section 4.4.1

addConstantFieldrefInfo

public short addConstantFieldrefInfo(String classFd,
 String fieldName,
 String fieldFd)

Adds a "CONSTANT_Fieldref_info" structure to the class file.

See Also:

• JVM specification, section 4.4.2

addConstantMethodrefInfo

public short addConstantMethodrefInfo(String classFd,
 String methodName,
 String methodMd)

Adds a "CONSTANT_Methodref_info" structure to the class file.

See Also:

• JVM specification, section 4.4.2

addConstantInterfaceMethodrefInfo

public short addConstantInterfaceMethodrefInfo(String classFd,
 String methodName,
 String methodMd)

Adds a "CONSTANT_InterfaceMethodref_info" structure to the class file.

See Also:

• JVM specification, section 4.4.2

addConstantStringInfo

public short addConstantStringInfo(String string)

Adds a "CONSTANT_String_info" structure to the class file.

See Also:

• JVM specification, section 4.4.3

addConstantIntegerInfo

public short addConstantIntegerInfo(int value)

Adds a "CONSTANT_Integer_info" structure to the class file.

See Also:

• JVM specification, section 4.4.4

addConstantFloatInfo

public short addConstantFloatInfo(float value)

Adds a "CONSTANT_Float_info" structure to the class file.

See Also:

• JVM specification, section 4.4.4

addConstantLongInfo

public short addConstantLongInfo(long value)

Adds a "CONSTANT_Long_info" structure to the class file.

See Also:

• JVM specification, section 4.4.5

addConstantDoubleInfo

public short addConstantDoubleInfo(double value)

Adds a "CONSTANT_Double_info" structure to the class file.

See Also:

• JVM specification, section 4.4.5

addConstantNameAndTypeInfo

private short addConstantNameAndTypeInfo(String name,
 String descriptor)

Adds a "CONSTANT_NameAndType_info" structure to the class file.

See Also:

• JVM specification, section 4.4.6

addConstantUtf8Info

public short addConstantUtf8Info(String s)

Adds a "CONSTANT_Utf8_info" structure to the class file if no equal entry exists.

Returns:

The index of the already existing or newly created entry

See Also:

• JVM specification, section 4.4.7

addConstantSifldInfo

private short addConstantSifldInfo(Object cv)

Convenience method that adds a String, Integer, Float, Long or Double ConstantInfo.

addToConstantPool

private short addToConstantPool(ClassFile.ConstantPoolInfo cpi)

Adds an entry to the constant pool and returns its index, or, if an equal entry already exists in the constant pool, returns the index of that entry.

addFieldInfo

public ClassFile.FieldInfo addFieldInfo(short accessFlags,
 String fieldName,
 String fieldTypeFd,
 @Nullable
 Object constantValue)

Creates a ClassFile.FieldInfo and adds it to this class. The return value can be used e.g. to add attributes (Deprecated, ...) to the field.

addMethodInfo

public ClassFile.MethodInfo addMethodInfo(short accessFlags,
 String methodName,
 MethodDescriptor methodMd)

Creates a ClassFile.MethodInfo and adds it to this class. The return value can be used e.g. to add attributes (Code, Deprecated, Exceptions, ...) to the method.

getConstantPoolInfo

public ClassFile.ConstantPoolInfo getConstantPoolInfo(short index)

Returns:

The (read-only) constant pool entry indexed by index

Throws:

ClassFile.ClassFileException - index is invalid

getConstantClassInfo

public ClassFile.ConstantClassInfo getConstantClassInfo(short index)

Returns:

The (read-only) constant class info indexed by index

getConstantFieldrefInfo

public ClassFile.ConstantFieldrefInfo getConstantFieldrefInfo(short index)

Returns:

The (read-only) constant fieldref info indexed by index

getConstantInterfaceMethodrefInfo

public ClassFile.ConstantInterfaceMethodrefInfo getConstantInterfaceMethodrefInfo(short index)

Returns:

The (read-only) constant interface methodref info indexed by index

getConstantInvokeDynamicInfo

public ClassFile.ConstantInvokeDynamicInfo getConstantInvokeDynamicInfo(short index)

Returns:

The (read-only) constant invoke dynamic info indexed by index

getConstantMethodHandleInfo

public ClassFile.ConstantMethodHandleInfo getConstantMethodHandleInfo(short index)

Returns:

The (read-only) constant method handle info indexed by index

getConstantMethodrefInfo

public ClassFile.ConstantMethodrefInfo getConstantMethodrefInfo(short index)

Returns:

The (read-only) constant methodref info indexed by index

getConstantMethodTypeInfo

public ClassFile.ConstantMethodTypeInfo getConstantMethodTypeInfo(short index)

Returns:

The (read-only) constant method type info indexed by index

getConstantNameAndTypeInfo

public ClassFile.ConstantNameAndTypeInfo getConstantNameAndTypeInfo(short index)

Returns:

The (read-only) constant name and type info indexed by index

getConstantUtf8Info

public ClassFile.ConstantUtf8Info getConstantUtf8Info(short index)

Returns:

The (read-only) constant utf8 info indexed by index

getConstantValuePoolInfo

public ClassFile.ConstantValuePoolInfo getConstantValuePoolInfo(short index)

Returns:

The (read-only) constant value pool info indexed by index

getConstantPoolSize

public int getConstantPoolSize()

Returns:

The size of the constant pool

getConstantUtf8

public String getConstantUtf8(short index)

Shorthand for getConstantUtf8Info(index).s.

Parameters:

index - Index to a CONSTANT_Utf8_info in the constant pool

Returns:

The string represented by the structure

readLengthAndBytes

private static byte[] readLengthAndBytes(DataInputStream dis)
                                  throws IOException

u4 length, u1[length]

Throws:

IOException

readShortArray

private static short[] readShortArray(DataInputStream dis)
                               throws IOException

u2 length, u2[length]

Throws:

IOException

loadConstantPool

private void loadConstantPool(DataInputStream dis)
                       throws IOException

u2 constant_pool_count, constant_pool[constant_pool_count]

Throws:

IOException

loadFields

private List<ClassFile.FieldInfo> loadFields(DataInputStream dis)
                                      throws IOException

u2 fields_count, fields[fields_count]

Throws:

IOException

loadMethods

private List<ClassFile.MethodInfo> loadMethods(DataInputStream dis)
                                        throws IOException

u2 methods_count, methods[methods_count]

Throws:

IOException

loadAttributes

private List<ClassFile.AttributeInfo> loadAttributes(DataInputStream dis)
                                              throws IOException

u2 attributes_count, attributes[attributes_count]

Throws:

IOException

store

public void store(OutputStream os)
           throws IOException

Writes 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.

Throws:

IOException

storeConstantPool

private static void storeConstantPool(DataOutputStream dos,
 List<ClassFile.ConstantPoolInfo> constantPool)
                               throws IOException

u2 constant_pool_count, constant_pool[constant_pool_count - 1]

Throws:

IOException

storeShortArray

private static void storeShortArray(DataOutputStream dos,
 short[] sa)
                             throws IOException

u2 count, u2[count]

Throws:

IOException

storeFields

private static void storeFields(DataOutputStream dos,
 List<ClassFile.FieldInfo> fieldInfos)
                         throws IOException

u2 fields_count, fields[fields_count]

Throws:

IOException

storeMethods

private static void storeMethods(DataOutputStream dos,
 List<ClassFile.MethodInfo> methodInfos)
                          throws IOException

u2 methods_count, methods[methods_count]

Throws:

IOException

storeAttributes

private static void storeAttributes(DataOutputStream dos,
 List<ClassFile.AttributeInfo> attributeInfos)
                             throws IOException

u2 attributes_count, attributes[attributes_count]

Throws:

IOException

getSourceResourceName

public static String getSourceResourceName(String className)

Constructs the name of a resource that could contain the source code of the class with the className.

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 String getClassFileResourceName(String className)

Constructs the name of a resource that could contain the class file of the class with the className.

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()

Returns the byte code of this ClassFile as a byte array.

loadMethodInfo

private ClassFile.MethodInfo loadMethodInfo(DataInputStream dis)
                                     throws IOException

Throws:

IOException

loadAttribute

private ClassFile.AttributeInfo loadAttribute(DataInputStream dis)
                                       throws IOException

Loads one class file attribute. The returned object will be of ClassFile.AttributeInfo-derived type, depending on the attribute's name; e.g. if the name of the attribute is "SourceFile", then the returned object will be of type ClassFile.SourceFileAttribute.

Throws:

IOException

loadElementValue

private static ClassFile.ElementValue loadElementValue(DataInputStream dis)
                                                throws IOException

Throws:

IOException

newObjectVariableInfo

public ClassFile.StackMapTableAttribute.ObjectVariableInfo newObjectVariableInfo(String fieldDescriptor)

newUninitializedVariableInfo

public ClassFile.StackMapTableAttribute.UninitializedVariableInfo newUninitializedVariableInfo(short offset)

toString

public String toString()

Overrides:

toString in class Object