Class ClassHolder
- java.lang.Object
-
- org.apache.derby.iapi.services.classfile.ClassHolder
-
- Direct Known Subclasses:
ClassInvestigator
public class ClassHolder extends java.lang.ObjectBased upon "THE class FILE FORMAT" chapter of "The Java Virtual Machine Specification" corresponding to version 1.0.2 of the Java Virtual Machine and 1.0.2 of the Java Language Specification. ISBN 0-201-63452-X, September 1996.
-
-
Field Summary
Fields Modifier and Type Field Description protected intaccess_flagsprotected Attributesattribute_infoprotected java.util.Vector<ConstantPoolEntry>cptEntriesprivate intcptEstimatedSizeprotected java.util.Hashtable<java.lang.Object,ConstantPoolEntry>cptHashTableprotected MemberTablefield_infoprotected int[]interfacesprotected intmajor_versionMinor class format number defaults to VMDescriptor.JAVA_CLASS_FORMAT_MAJOR_VERSIONprotected MemberTablemethod_infoprotected intminor_versionMinor class format number defaults to VMDescriptor.JAVA_CLASS_FORMAT_MINOR_VERSION which currently corresponds to a really old (JDK 1.0.2) setting.private CONSTANT_Index_infosearchIndexUsed to search for index entries to avoid object allocation in the case a referecne already exists.protected intsuper_classprotected intthis_class
-
Constructor Summary
Constructors Modifier Constructor Description protectedClassHolder(int estimatedConstantPoolCount)ClassHolder(java.lang.String fullyQualifiedName, java.lang.String superClassName, int modifiers)This will not define a constructor -- it is up to the caller to add at least one.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddAttribute(java.lang.String attributeName, ClassFormatOutput info)intaddClassReference(java.lang.String fullyQualifiedName)Add a class entry to the pool.intaddConstant(double value)intaddConstant(float value)intaddConstant(int value)intaddConstant(long value)intaddConstant(java.lang.String value)private intaddDirectEntry(ConstantPoolEntry item)Add an entry, but only if it doesn't exist.protected intaddEntry(java.lang.Object key, ConstantPoolEntry item)Generic add entry to constant pool.private CONSTANT_Utf8_infoaddExtraUtf8(java.lang.String value)Add an extra UTF8 into the poolintaddFieldReference(java.lang.String className, java.lang.String simpleName, java.lang.String descriptor)intaddFieldReference(ClassMember field)private intaddIndexReference(int tag, int i1, int i2)Add an index reference.ClassMemberaddMember(java.lang.String simpleName, java.lang.String descriptor, int modifier)intaddMethodReference(java.lang.String className, java.lang.String simpleName, java.lang.String descriptor, boolean isInterface)private intaddNameAndType(java.lang.String name, java.lang.String descriptor)Add a name and type entryprivate intaddReference(int tag, java.lang.String className, java.lang.String simpleName, java.lang.String descriptor)private intaddReference(int tag, ClassMember member)private intaddString(java.lang.String value)Add a string entryintaddUtf8(java.lang.String value)private CONSTANT_Utf8_infoaddUtf8Entry(java.lang.String value)Add a UTF8 into the pool and return the index to it.protected java.lang.StringclassName(int classIndex)Return the class name for an index to a CONSTANT_Class_info.private static java.lang.StringconvertToInternal(java.lang.String externalName, boolean descriptor)static java.lang.StringconvertToInternalClassName(java.lang.String externalName)static java.lang.StringconvertToInternalDescriptor(java.lang.String externalName)protected voidcptPut(ClassFormatOutput out)intfindClass(java.lang.String fullyQualifiedName)Find a class descriptor (section 4.4.1) and return its index, returns -1 if not found.protected CONSTANT_Index_infofindIndexEntry(int tag, int i1, int i2)protected intfindIndexIndex(int tag, int i1, int i2)protected ConstantPoolEntryfindMatchingEntry(java.lang.Object key)intfindNameAndType(java.lang.String name, java.lang.String descriptor)Find a name and type descriptor (section 4.4.6) and return it's index.(package private) intfindUtf8(java.lang.String value)Return the index of a UTF entry or -1 if it doesn't exist.protected java.lang.StringgetClassName(int index)get the class name of a Class given the index of its CONSTANT_Class_info entry in the Constant Pool.intgetConstantPoolIndex()ConstantPoolEntrygetEntry(int index)ByteArraygetFileFormat()Convert the object representation of the class into its class file format.intgetModifier()java.lang.StringgetName()java.lang.StringgetSuperClassName()static booleanisExternalClassName(java.lang.String className)private static java.lang.StringmakeDesc(char builtin, int arity)A helper to build a type description based on a built-in type and an array arity.private static java.lang.StringmakeDesc(java.lang.String className, int arity, boolean descriptor)A helper to build a type description based on a Java class and an array arity.(package private) java.lang.StringnameIndexToString(int index)get a string (UTF) given a name_index into the constant poolprivate voidput(ClassFormatOutput out)
-
-
-
Field Detail
-
minor_version
protected int minor_version
Minor class format number defaults to VMDescriptor.JAVA_CLASS_FORMAT_MINOR_VERSION which currently corresponds to a really old (JDK 1.0.2) setting. The default major and minor value is used by the generated code for Derby's SQL statements. Currently there is no need to bump the version number as the generated code does not take advantage of any of the new elements in the class file format. If such a need exists then this can be bumped. One issue is that the change in format numbers is not well documented.
-
major_version
protected int major_version
Minor class format number defaults to VMDescriptor.JAVA_CLASS_FORMAT_MAJOR_VERSION
-
access_flags
protected int access_flags
-
this_class
protected int this_class
-
super_class
protected int super_class
-
interfaces
protected int[] interfaces
-
field_info
protected MemberTable field_info
-
method_info
protected MemberTable method_info
-
attribute_info
protected Attributes attribute_info
-
cptHashTable
protected java.util.Hashtable<java.lang.Object,ConstantPoolEntry> cptHashTable
-
cptEntries
protected java.util.Vector<ConstantPoolEntry> cptEntries
-
cptEstimatedSize
private int cptEstimatedSize
-
searchIndex
private final CONSTANT_Index_info searchIndex
Used to search for index entries to avoid object allocation in the case a referecne already exists.
-
-
Method Detail
-
put
private void put(ClassFormatOutput out) throws java.io.IOException
- Throws:
java.io.IOException
-
getFileFormat
public ByteArray getFileFormat() throws java.io.IOException
Convert the object representation of the class into its class file format.- Throws:
java.io.IOException- error writing the class
-
getModifier
public int getModifier()
- See Also:
ClassMember
-
getName
public java.lang.String getName()
- See Also:
ClassMember
-
addMember
public ClassMember addMember(java.lang.String simpleName, java.lang.String descriptor, int modifier)
-
addFieldReference
public int addFieldReference(java.lang.String className, java.lang.String simpleName, java.lang.String descriptor)
-
addFieldReference
public int addFieldReference(ClassMember field)
-
addMethodReference
public int addMethodReference(java.lang.String className, java.lang.String simpleName, java.lang.String descriptor, boolean isInterface)
-
addReference
private int addReference(int tag, java.lang.String className, java.lang.String simpleName, java.lang.String descriptor)
-
addReference
private int addReference(int tag, ClassMember member)
-
addConstant
public int addConstant(java.lang.String value)
- See Also:
addConstant(java.lang.String)
-
addUtf8
public int addUtf8(java.lang.String value)
- See Also:
addUtf8(java.lang.String)
-
addConstant
public int addConstant(int value)
- See Also:
addConstant(java.lang.String)
-
addConstant
public int addConstant(float value)
- See Also:
addConstant(java.lang.String)
-
addConstant
public int addConstant(long value)
- See Also:
addConstant(java.lang.String)
-
addConstant
public int addConstant(double value)
- See Also:
addConstant(java.lang.String)
-
getConstantPoolIndex
public int getConstantPoolIndex()
- See Also:
ClassMember
-
addAttribute
public void addAttribute(java.lang.String attributeName, ClassFormatOutput info)
-
getSuperClassName
public java.lang.String getSuperClassName()
-
addEntry
protected int addEntry(java.lang.Object key, ConstantPoolEntry item)Generic add entry to constant pool. Includes the logic for an entry to occupy more than one slot (e.g. long).- Returns:
- The number of slots occupied by the entry. .
-
addDirectEntry
private int addDirectEntry(ConstantPoolEntry item)
Add an entry, but only if it doesn't exist.- Returns:
- the constant pool index of the added or existing item.
-
addIndexReference
private int addIndexReference(int tag, int i1, int i2)Add an index reference.
-
addClassReference
public int addClassReference(java.lang.String fullyQualifiedName)
Add a class entry to the pool.
-
addNameAndType
private int addNameAndType(java.lang.String name, java.lang.String descriptor)Add a name and type entry
-
addUtf8Entry
private CONSTANT_Utf8_info addUtf8Entry(java.lang.String value)
Add a UTF8 into the pool and return the index to it.
-
addExtraUtf8
private CONSTANT_Utf8_info addExtraUtf8(java.lang.String value)
Add an extra UTF8 into the pool
-
addString
private int addString(java.lang.String value)
Add a string entry
-
cptPut
protected void cptPut(ClassFormatOutput out) throws java.io.IOException
- Throws:
java.io.IOException
-
getEntry
public ConstantPoolEntry getEntry(int index)
-
className
protected java.lang.String className(int classIndex)
Return the class name for an index to a CONSTANT_Class_info.
-
findUtf8
int findUtf8(java.lang.String value)
Return the index of a UTF entry or -1 if it doesn't exist.
-
findClass
public int findClass(java.lang.String fullyQualifiedName)
Find a class descriptor (section 4.4.1) and return its index, returns -1 if not found.
-
findNameAndType
public int findNameAndType(java.lang.String name, java.lang.String descriptor)Find a name and type descriptor (section 4.4.6) and return it's index.returns -1 if not found.
-
findIndexEntry
protected CONSTANT_Index_info findIndexEntry(int tag, int i1, int i2)
-
findIndexIndex
protected int findIndexIndex(int tag, int i1, int i2)
-
findMatchingEntry
protected ConstantPoolEntry findMatchingEntry(java.lang.Object key)
-
nameIndexToString
java.lang.String nameIndexToString(int index)
get a string (UTF) given a name_index into the constant pool
-
getClassName
protected java.lang.String getClassName(int index)
get the class name of a Class given the index of its CONSTANT_Class_info entry in the Constant Pool.
-
isExternalClassName
public static boolean isExternalClassName(java.lang.String className)
-
convertToInternalClassName
public static java.lang.String convertToInternalClassName(java.lang.String externalName)
-
convertToInternalDescriptor
public static java.lang.String convertToInternalDescriptor(java.lang.String externalName)
-
convertToInternal
private static java.lang.String convertToInternal(java.lang.String externalName, boolean descriptor)
-
makeDesc
private static java.lang.String makeDesc(char builtin, int arity)A helper to build a type description based on a built-in type and an array arity.
-
makeDesc
private static java.lang.String makeDesc(java.lang.String className, int arity, boolean descriptor)A helper to build a type description based on a Java class and an array arity. If descriptor is true create a descriptor according to section 4.3.2 of the vm spec. If false create a class name according to sections 4.3.2 and 4.4.1 of the vm spec.
-
-