Class ClassParser

java.lang.Object

edu.umd.cs.findbugs.classfile.engine.ClassParser

All Implemented Interfaces:

ClassParserInterface

public class ClassParser
extends Object
implements ClassParserInterface

Parse a class to extract symbolic information. see http://java.sun.com/docs/books/vmspec/2nd-edition/html/ClassFile.doc.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	ClassParser.Constant
(package private) static interface	ClassParser.FieldOrMethodDescriptorCreator<E>

Field Summary

Fields

Modifier and Type	Field	Description
private final ICodeBaseEntry	codeBaseEntry
private static final String[]	CONSTANT_FORMAT_MAP
private ClassParser.Constant[]	constantPool
private final ClassDescriptor	expectedClassDescriptor
private final DataInputStream	in

Constructor Summary

Constructors

Constructor	Description
ClassParser(DataInputStream in, ClassDescriptor expectedClassDescriptor, ICodeBaseEntry codeBaseEntry)	Constructor.

Method Summary

Modifier and Type	Method	Description
private void	checkConstantPoolIndex(int index)	Check that a constant pool index is valid.
private void	checkConstantTag(ClassParser.Constant constant, int expectedTag)	Check that a constant has the expected tag.
private Collection<ClassDescriptor>	extractReferencedClasses()	Extract references to other classes.
static void	extractReferencedClassesFromSignature(Set<ClassDescriptor> referencedClassSet, String signature)
private ClassDescriptor	getClassDescriptor(int index)	Get the ClassDescriptor of a class referenced in the constant pool.
private String	getClassName(int index)	Get a class name from a CONSTANT_Class.
private String	getSignatureFromNameAndType(int index)	Get the signature from a CONSTANT_NameAndType.
private String	getUtf8String(int refIndex)	Get the UTF-8 string constant at given constant pool index.
void	parse(ClassInfo.Builder builder)	Parse the class data into a ClassInfo object containing (some of) the class's symbolic information.
void	parse(ClassNameAndSuperclassInfo.Builder builder)	Parse the class data into a ClassNameAndSuperclassInfo object containing (some of) the class's symbolic information.
private ClassParser.Constant	readConstant()	Read a constant from the constant pool.

Methods inherited from class Object

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

Field Details

in

private final DataInputStream in

expectedClassDescriptor

private final ClassDescriptor expectedClassDescriptor

codeBaseEntry

private final ICodeBaseEntry codeBaseEntry

constantPool

private ClassParser.Constant[] constantPool

CONSTANT_FORMAT_MAP

private static final String[] CONSTANT_FORMAT_MAP

Constructor Details

ClassParser

public ClassParser(DataInputStream in,
 @CheckForNull
 ClassDescriptor expectedClassDescriptor,
 ICodeBaseEntry codeBaseEntry)

Constructor.

Parameters:

in - the DataInputStream to read class data from

expectedClassDescriptor - ClassDescriptor expected: null if unknown

codeBaseEntry - codebase entry class is loaded from

Method Details

parse

public void parse(ClassNameAndSuperclassInfo.Builder builder)
           throws InvalidClassFileFormatException

Description copied from interface: ClassParserInterface

Parse the class data into a ClassNameAndSuperclassInfo object containing (some of) the class's symbolic information.

Specified by:

parse in interface ClassParserInterface

Parameters:

builder - a ClassNameAndSuperclassInfo object to be filled in with (some of) the class's symbolic information

Throws:

InvalidClassFileFormatException

parse

public void parse(ClassInfo.Builder builder)
           throws InvalidClassFileFormatException

Description copied from interface: ClassParserInterface

Parse the class data into a ClassInfo object containing (some of) the class's symbolic information.

Specified by:

parse in interface ClassParserInterface

Parameters:

builder - a ClassInfo object to be filled in with (some of) the class's symbolic information

Throws:

InvalidClassFileFormatException

extractReferencedClasses

private Collection<ClassDescriptor> extractReferencedClasses()
                                                      throws InvalidClassFileFormatException

Extract references to other classes.

Returns:

array of ClassDescriptors of referenced classes

Throws:

InvalidClassFileFormatException

extractReferencedClassesFromSignature

public static void extractReferencedClassesFromSignature(Set<ClassDescriptor> referencedClassSet,
 String signature)

readConstant

private ClassParser.Constant readConstant()
                                   throws InvalidClassFileFormatException,
IOException

Read a constant from the constant pool. Return null for

Returns:

a StaticConstant

Throws:

InvalidClassFileFormatException

IOException

getClassName

@SlashedClassName
private String getClassName(int index)
                     throws InvalidClassFileFormatException

Get a class name from a CONSTANT_Class. Note that this may be an array (e.g., "[Ljava/lang/String;").

Parameters:

index - index of the constant

Returns:

the class name

Throws:

InvalidClassFileFormatException

getClassDescriptor

private ClassDescriptor getClassDescriptor(int index)
                                    throws InvalidClassFileFormatException

Get the ClassDescriptor of a class referenced in the constant pool.

Parameters:

index - index of the referenced class in the constant pool

Returns:

the ClassDescriptor of the referenced class

Throws:

InvalidClassFileFormatException

getUtf8String

private String getUtf8String(int refIndex)
                      throws InvalidClassFileFormatException

Get the UTF-8 string constant at given constant pool index.

Parameters:

refIndex - the constant pool index

Returns:

the String at that index

Throws:

InvalidClassFileFormatException

checkConstantPoolIndex

private void checkConstantPoolIndex(int index)
                             throws InvalidClassFileFormatException

Check that a constant pool index is valid.

Parameters:

index - the index to check

Throws:

InvalidClassFileFormatException - if the index is not valid

checkConstantTag

private void checkConstantTag(ClassParser.Constant constant,
 int expectedTag)
                       throws InvalidClassFileFormatException

Check that a constant has the expected tag.

Parameters:

constant - the constant to check

expectedTag - the expected constant tag

Throws:

InvalidClassFileFormatException - if the constant's tag does not match the expected tag

getSignatureFromNameAndType

private String getSignatureFromNameAndType(int index)
                                    throws InvalidClassFileFormatException

Get the signature from a CONSTANT_NameAndType.

Parameters:

index - the index of the CONSTANT_NameAndType

Returns:

the signature

Throws:

InvalidClassFileFormatException