org.macroing.cel4j.java.binary.reader

Class ClassFileReader

java.lang.Object

org.macroing.cel4j.java.binary.reader.ClassFileReader

public final class ClassFileReader
extends java.lang.Object

A ClassFileReader is used for reading ClassFiles from binary data.

This class is not thread-safe.

Since:

1.0.0

Author:

Jörgen Lundgren

Constructor Summary

Constructors

Constructor and Description
ClassFileReader() Constructs a new ClassFileReader instance.

Method Summary

Modifier and Type	Method and Description
static ClassFileReader	newInstance() Returns a new ClassFileReader instance.
ClassFile	readClassFile(java.lang.Class<?> clazz) Returns a ClassFile representation of clazz, by reading its binary data.
ClassFile	readClassFile(java.io.DataInput dataInput) Returns a ClassFile, by reading some binary data from dataInput.
ClassFile	readClassFile(java.io.File file) Returns a ClassFile, by reading some binary data given a File.
ClassFile	readClassFile(java.lang.String className) Returns a ClassFile representation of the Class that can be obtained by Class.forName(className), by reading its binary data.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassFileReader

public ClassFileReader()

Constructs a new ClassFileReader instance.

Method Detail

readClassFile

public ClassFile readClassFile(java.lang.Class<?> clazz)

Returns a ClassFile representation of clazz, by reading its binary data.

If clazz is null, a NullPointerException will be thrown.

If the read binary data is invalid for some reason, a NodeFormatException will be thrown.

Parameters:

clazz - the Class from which to read binary data into a ClassFile instance

Returns:

a ClassFile representation of clazz, by reading its binary data

Throws:

NodeFormatException - thrown if, and only if, the read binary data is invalid

java.lang.NullPointerException - thrown if, and only if, clazz is null

readClassFile

public ClassFile readClassFile(java.io.DataInput dataInput)

Returns a ClassFile, by reading some binary data from dataInput.

If dataInput is null, a NullPointerException will be thrown.

If the read binary data is invalid for some reason, a NodeFormatException will be thrown.

Parameters:

dataInput - the DataInput from which to read binary data into a ClassFile instance

Returns:

a ClassFile, by reading some binary data from dataInput

Throws:

NodeFormatException - thrown if, and only if, the read binary data is invalid

java.lang.NullPointerException - thrown if, and only if, dataInput is null

readClassFile

public ClassFile readClassFile(java.io.File file)

Returns a ClassFile, by reading some binary data given a File.

If file is null, a NullPointerException will be thrown.

If the read binary data is invalid for some reason, a NodeFormatException will be thrown.

Parameters:

file - the File from which to read binary data into a ClassFile instance

Returns:

a ClassFile, by reading some binary data given a File

Throws:

NodeFormatException - thrown if, and only if, the read binary data is invalid

java.lang.NullPointerException - thrown if, and only if, file is null

readClassFile

public ClassFile readClassFile(java.lang.String className)

Returns a ClassFile representation of the Class that can be obtained by Class.forName(className), by reading its binary data.

If className is null, a NullPointerException will be thrown.

If the read binary data is invalid for some reason, or no such Class exists, a NodeFormatException will be thrown.

Parameters:

className - the name of the Class from which to read binary data into a ClassFile instance

Returns:

a ClassFile representation of the Class that can be obtained by Class.forName(className), by reading its binary data

Throws:

NodeFormatException - thrown if, and only if, the read binary data is invalid, or no such Class exists

java.lang.NullPointerException - thrown if, and only if, className is null

newInstance

public static ClassFileReader newInstance()

Returns a new ClassFileReader instance.

Returns:

a new ClassFileReader instance