org.jace.parser

Class ClassFile

java.lang.Object

org.jace.parser.ClassFile

public class ClassFile
extends Object

A representation of the java class file format.

Author:

Toby Reyelts, Gili Tzabari

Constructor Summary

Constructors

Constructor and Description
ClassFile(File path) Creates a new ClassFile on the given class file.
ClassFile(InputStream clazz) Creates a new ClassFile on the given class definition.

Method Summary

Methods

Modifier and Type	Method and Description
ClassAccessFlagSet	getAccessFlags() Returns the set of access flags for this class.
List<Attribute>	getAttributes() Returns the Attributes for a class.
TypeName	getClassName() Returns the name of the class.
ConstantPool	getConstantPool() Returns the class constant pool.
List<ClassField>	getFields() Returns the ClassFields for this class.
Collection<Integer>	getInterfaceIndices() Returns the constant pool indices of the implemented interfaces.
Collection<TypeName>	getInterfaces() Returns the names of the implemented interfaces.
int	getMajorVersion() Returns the major version.
List<ClassMethod>	getMethods() Returns the ClassMethods for this class.
int	getMinorVersion() Returns the minor version.
TypeName	getSuperClassName() Returns the name of the super class.
static void	main(String[] args) Prints out the detail of the specified class.
void	setAccessFlags(ClassAccessFlagSet set) Sets the set of access flags for this class.
void	setClassName(TypeName name) Sets the name of the class.
void	setSuperClassName(TypeName name) Sets the name of the super class.
void	setVersion(int major, int minor) Changes the class file version.
String	toString()
void	writeAccessFlags(DataOutputStream output) Writes the access flags.
void	writeAttributes(DataOutputStream output) Writes the class attributes.
void	writeClass(OutputStream stream) Writes the class file.
void	writeClass(String path) Writes the class file.
void	writeClassName(DataOutputStream output) Writes the class name.
void	writeFields(DataOutputStream output) Writes the class fields.
void	writeInterfaces(DataOutputStream output) Writes the implemented interfaces.
void	writeMethods(DataOutputStream output) Writes the class methods.
void	writeSuperClass(DataOutputStream output) Writes the super class extended.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassFile

public ClassFile(InputStream clazz)
          throws ClassFormatError

Creates a new ClassFile on the given class definition.

Parameters:

clazz - the class stream

Throws:

ClassFormatError - if an error occurs while parsing the class file

ClassFile

public ClassFile(File path)
          throws IOException,
                 ClassFormatError

Creates a new ClassFile on the given class file.

Parameters:

path - the class file path

Throws:

ClassFormatError - if an error occurs while parsing the class file

IOException - if the file could not be opened

Method Detail

getClassName

public TypeName getClassName()

Returns the name of the class.

Returns:

the name of the class

setClassName

public void setClassName(TypeName name)

Sets the name of the class.

Parameters:

name - the name of the class

getSuperClassName

public TypeName getSuperClassName()

Returns the name of the super class.

Returns:

null if the class is java.lang.Object

setSuperClassName

public void setSuperClassName(TypeName name)

Sets the name of the super class.

Parameters:

name - the name of the super class

getInterfaces

public Collection<TypeName> getInterfaces()

Returns the names of the implemented interfaces.

Returns:

the names of the implemented interfaces

getInterfaceIndices

public Collection<Integer> getInterfaceIndices()

Returns the constant pool indices of the implemented interfaces.

Returns:

the constant pool indices of the implemented interfaces

getFields

public List<ClassField> getFields()

Returns the ClassFields for this class.

Returns:

the ClassFields for this class

getMethods

public List<ClassMethod> getMethods()

Returns the ClassMethods for this class.

Returns:

the ClassMethods for this class

getMajorVersion

public int getMajorVersion()

Returns the major version.

Returns:

the major version

getMinorVersion

public int getMinorVersion()

Returns the minor version.

Returns:

the minor version

setVersion

public void setVersion(int major,
              int minor)

Changes the class file version. Internally handles format changes.

Parameters:

major - the major version

minor - the minor version

getAccessFlags

public ClassAccessFlagSet getAccessFlags()

Returns the set of access flags for this class.

Returns:

the set of access flags for this class

setAccessFlags

public void setAccessFlags(ClassAccessFlagSet set)

Sets the set of access flags for this class.

Parameters:

set - the set of access flags for this class

writeClass

public void writeClass(String path)
                throws IOException

Writes the class file.

Parameters:

path - the class path

Throws:

IOException - if an error occurs while writing

writeClass

public void writeClass(OutputStream stream)
                throws IOException

Writes the class file.

Parameters:

stream - the output stream

Throws:

IOException - if an error occurs while writing

writeAccessFlags

public void writeAccessFlags(DataOutputStream output)
                      throws IOException

Writes the access flags.

Parameters:

output - the output stream

Throws:

IOException - if an error occurs while writing the class

writeClassName

public void writeClassName(DataOutputStream output)
                    throws IOException

Writes the class name.

Parameters:

output - the output stream

Throws:

IOException - if an error occurs while writing the class

writeSuperClass

public void writeSuperClass(DataOutputStream output)
                     throws IOException

Writes the super class extended.

Parameters:

output - the output stream

Throws:

IOException - if an error occurs while writing the class

writeInterfaces

public void writeInterfaces(DataOutputStream output)
                     throws IOException

Writes the implemented interfaces.

Parameters:

output - the output stream

Throws:

IOException - if an error occurs while writing the class

writeFields

public void writeFields(DataOutputStream output)
                 throws IOException

Writes the class fields.

Parameters:

output - the output stream

Throws:

IOException - if an error occurs while writing the class

writeMethods

public void writeMethods(DataOutputStream output)
                  throws IOException

Writes the class methods.

Parameters:

output - the output stream

Throws:

IOException - if an error occurs while writing the class

writeAttributes

public void writeAttributes(DataOutputStream output)
                     throws IOException

Writes the class attributes.

Parameters:

output - the output stream

Throws:

IOException - if an error occurs while writing the class

getAttributes

public List<Attribute> getAttributes()

Returns the Attributes for a class.

Returns:

the class attributes

getConstantPool

public ConstantPool getConstantPool()

Returns the class constant pool.

Returns:

the class constant pool.

toString

public String toString()

Overrides:

toString in class Object

main

public static void main(String[] args)
                 throws IOException

Prints out the detail of the specified class.

Parameters:

args - the command-line arguments

Throws:

IOException