plume

Class BCELUtil

java.lang.Object

plume.BCELUtil

Deprecated.

use org.plumelib.bcelutil.BcelUtil

@Deprecated
public final class BCELUtil
extends java.lang.Object

Static utility methods for working with BCEL.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	skip_checks Deprecated. Controls whether the checks in checkMgen are actually performed.

Method Summary

Modifier and Type	Method and Description
static void	add_line_numbers(org.apache.bcel.generic.MethodGen mg, org.apache.bcel.generic.InstructionList il) Deprecated. Builds an array of line numbers for the specified instruction list.
static void	add_to_start(org.apache.bcel.generic.MethodGen mg, org.apache.bcel.generic.InstructionList nl) Deprecated. Adds code in nl to start of method mg.
static org.apache.bcel.generic.Type[]	add_type(org.apache.bcel.generic.Type[] types, org.apache.bcel.generic.Type new_type) Deprecated. use postpendToArray(org.apache.bcel.generic.Type[], org.apache.bcel.generic.Type)
static void	checkMgen(org.apache.bcel.generic.MethodGen mgen) Deprecated. Checks the specific method for consistency.
static void	checkMgens(org.apache.bcel.generic.ClassGen gen) Deprecated. Checks all of the methods in gen for consistency.
static org.apache.bcel.generic.Type	classname_to_type(java.lang.String classname) Deprecated. Return the type corresponding to a given fully-qualified class name.
static void	dump(org.apache.bcel.classfile.JavaClass jc, java.io.File dump_dir) Deprecated. Dumps the contents of the specified class to the specified directory.
static void	dump(org.apache.bcel.classfile.JavaClass jc, java.lang.String dump_dir) Deprecated. Dumps the contents of the specified class to the specified directory.
static void	empty_method(org.apache.bcel.generic.MethodGen mg) Deprecated. Empties the method of all code (except for a return).
static java.lang.String	get_attribute_name(org.apache.bcel.classfile.Attribute a) Deprecated. Return the attribute name for the specified attribute.
static java.lang.String	get_attribute_name(org.apache.bcel.classfile.Attribute a, org.apache.bcel.generic.ConstantPoolGen pool) Deprecated. Return the attribute name for the specified attribute.
static java.lang.String	get_constant_str(org.apache.bcel.classfile.ConstantPool pool, int index) Deprecated. Returns the constant string at the specified offset.
static java.lang.String	get_method_declaration(org.apache.bcel.classfile.Method m) Deprecated. Returns a string describing a method declaration.
static boolean	in_jdk_internalform(java.lang.String classname) Deprecated. Returns whether or not the class is part of the JDK (rt.jar).
static boolean	in_jdk(org.apache.bcel.generic.ClassGen gen) Deprecated. Returns whether or not the class is part of the JDK (rt.jar).
static boolean	in_jdk(java.lang.String classname) Deprecated. Returns whether or not the class is part of the JDK (rt.jar).
static org.apache.bcel.generic.Type[]	insert_type(org.apache.bcel.generic.Type new_type, org.apache.bcel.generic.Type[] types) Deprecated. use prependToArray(org.apache.bcel.generic.Type, org.apache.bcel.generic.Type[])
static java.lang.String	instruction_descr(org.apache.bcel.generic.InstructionList il, org.apache.bcel.generic.ConstantPoolGen pool) Deprecated.
static boolean	is_clinit(org.apache.bcel.classfile.Method m) Deprecated. Returns whether or not the method is a class initializer.
static boolean	is_clinit(org.apache.bcel.generic.MethodGen mg) Deprecated. Returns whether or not the method is a class initializer.
static boolean	is_constructor(org.apache.bcel.classfile.Method m) Deprecated. Returns whether or not the method is a constructor.
static boolean	is_constructor(org.apache.bcel.generic.MethodGen mg) Deprecated. Returns whether or not the method is a constructor.
static boolean	is_local_variable_type_table(org.apache.bcel.classfile.Attribute a, org.apache.bcel.generic.ConstantPoolGen pool) Deprecated. Returns whether or not the specified attribute is a local variable type table.
static boolean	is_main(org.apache.bcel.generic.MethodGen mg) Deprecated. Returns whether or not this is a standard main method (static, name is 'main', and one argument of string array).
static java.lang.String	local_var_descr(org.apache.bcel.generic.MethodGen mg) Deprecated. Return a description of the local variables (one per line).
static org.apache.bcel.generic.Type[]	postpendToArray(org.apache.bcel.generic.Type[] types, org.apache.bcel.generic.Type new_type) Deprecated. Returns a copy of the given type array, with new_type added to the end.
static org.apache.bcel.generic.Type[]	prependToArray(org.apache.bcel.generic.Type new_type, org.apache.bcel.generic.Type[] types) Deprecated. Returns a copy of the given type array, with new_type inserted at the beginning.
static void	remove_local_variable_type_tables(org.apache.bcel.generic.MethodGen mg) Deprecated. Remove the local variable type table attribute (LVTT) from mg.
static void	setup_init_locals(org.apache.bcel.generic.MethodGen mg) Deprecated. Sets the locals to 'this' and each of the arguments.
static java.lang.Class<?>	type_to_class(org.apache.bcel.generic.Type type) Deprecated. Returns the class that corresponds to type.
static java.lang.String	type_to_classgetname(org.apache.bcel.generic.Type type) Deprecated. Returns the Java class name, in the format of Class.getName(), that corresponds to type.

Methods inherited from class java.lang.Object

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

Field Detail

skip_checks

public static boolean skip_checks

Deprecated.

Controls whether the checks in checkMgen are actually performed.

Method Detail

get_method_declaration

public static java.lang.String get_method_declaration(org.apache.bcel.classfile.Method m)

Deprecated.

Returns a string describing a method declaration. It contains the access flags (public, private, static, etc), the return type, the method name, and the types of each of its arguments.

Parameters:

m - the method

Returns:

a string describing the method declaration

get_attribute_name

public static java.lang.String get_attribute_name(org.apache.bcel.classfile.Attribute a)

Deprecated.

Return the attribute name for the specified attribute.

Parameters:

a - the attribute

Returns:

the attribute name for the specified attribute

get_constant_str

public static java.lang.String get_constant_str(org.apache.bcel.classfile.ConstantPool pool,
                                                int index)

Deprecated.

Returns the constant string at the specified offset.

Parameters:

pool - the constant pool

index - the index in the constant pool

Returns:

the constant string at the specified offset in the constant pool

is_constructor

public static boolean is_constructor(org.apache.bcel.generic.MethodGen mg)

Deprecated.

Returns whether or not the method is a constructor.

Parameters:

mg - the method to test

Returns:

true iff the method is a constructor

is_constructor

public static boolean is_constructor(org.apache.bcel.classfile.Method m)

Deprecated.

Returns whether or not the method is a constructor.

Parameters:

m - the method to test

Returns:

true iff the method is a constructor

is_clinit

public static boolean is_clinit(org.apache.bcel.generic.MethodGen mg)

Deprecated.

Returns whether or not the method is a class initializer.

Parameters:

mg - the method to test

Returns:

true iff the method is a class initializer

is_clinit

public static boolean is_clinit(org.apache.bcel.classfile.Method m)

Deprecated.

Returns whether or not the method is a class initializer.

Parameters:

m - the method to test

Returns:

true iff the method is a class initializer

in_jdk

public static boolean in_jdk(org.apache.bcel.generic.ClassGen gen)

Deprecated.

Returns whether or not the class is part of the JDK (rt.jar).

Parameters:

gen - the class to test

Returns:

true iff the class is part of the JDK (rt.jar)

in_jdk

public static boolean in_jdk(java.lang.String classname)

Deprecated.

Returns whether or not the class is part of the JDK (rt.jar).

Parameters:

classname - the class to test, in the format of Class.getName(); the class should not be an array

Returns:

true iff the class is part of the JDK (rt.jar)

in_jdk_internalform

public static boolean in_jdk_internalform(java.lang.String classname)

Deprecated.

Returns whether or not the class is part of the JDK (rt.jar).

Parameters:

classname - the class to test, in internal form

Returns:

true iff the class is part of the JDK (rt.jar)

checkMgen

public static void checkMgen(org.apache.bcel.generic.MethodGen mgen)

Deprecated.

Checks the specific method for consistency.

Parameters:

mgen - the class to check

checkMgens

public static void checkMgens(org.apache.bcel.generic.ClassGen gen)

Deprecated.

Checks all of the methods in gen for consistency.

Parameters:

gen - the class to check

add_to_start

public static void add_to_start(org.apache.bcel.generic.MethodGen mg,
                                org.apache.bcel.generic.InstructionList nl)

Deprecated.

Adds code in nl to start of method mg.

Parameters:

mg - method to be augmented

nl - instructions to prepend to the method

dump

public static void dump(org.apache.bcel.classfile.JavaClass jc,
                        java.lang.String dump_dir)

Deprecated.

Dumps the contents of the specified class to the specified directory. The file is named dump_dir/[class].bcel. It contains a synopsis of the fields and methods followed by the jvm code for each method.

Parameters:

jc - javaclass to dump

dump_dir - directory in which to write the file

See Also:

dump(JavaClass, File)

dump

public static void dump(org.apache.bcel.classfile.JavaClass jc,
                        java.io.File dump_dir)

Deprecated.

Dumps the contents of the specified class to the specified directory. The file is named dump_dir/[class].bcel. It contains a synopsis of the fields and methods followed by the jvm code for each method.

Parameters:

jc - javaclass to dump

dump_dir - directory in which to write the file

instruction_descr

public static java.lang.String instruction_descr(org.apache.bcel.generic.InstructionList il,
                                                 org.apache.bcel.generic.ConstantPoolGen pool)

Deprecated.

local_var_descr

public static java.lang.String local_var_descr(org.apache.bcel.generic.MethodGen mg)

Deprecated.

Return a description of the local variables (one per line).

Parameters:

mg - the method whose local variables to describe

Returns:

a description of the local variables (one per line)

add_line_numbers

public static void add_line_numbers(org.apache.bcel.generic.MethodGen mg,
                                    org.apache.bcel.generic.InstructionList il)

Deprecated.

Builds an array of line numbers for the specified instruction list. Each opcode is assigned the next source line number starting at 1000.

Parameters:

mg - the method whose line numbers to extract

il - the instruction list to augment with line numbers

setup_init_locals

public static void setup_init_locals(org.apache.bcel.generic.MethodGen mg)

Deprecated.

Sets the locals to 'this' and each of the arguments. Any other locals are removed. An instruction list with at least one instruction must exist.

Parameters:

mg - the method whose locals to set

empty_method

public static void empty_method(org.apache.bcel.generic.MethodGen mg)

Deprecated.

Empties the method of all code (except for a return). This includes line numbers, exceptions, local variables, etc.

Parameters:

mg - the method to clear out

remove_local_variable_type_tables

public static void remove_local_variable_type_tables(org.apache.bcel.generic.MethodGen mg)

Deprecated.

Remove the local variable type table attribute (LVTT) from mg. Evidently some changes require this to be updated, but without BCEL support that would be hard to do. It should be safe to just delete it since it is optional and really only of use to a debugger.

Parameters:

mg - the method to clear out

is_local_variable_type_table

public static boolean is_local_variable_type_table(org.apache.bcel.classfile.Attribute a,
                                                   org.apache.bcel.generic.ConstantPoolGen pool)

Deprecated.

Returns whether or not the specified attribute is a local variable type table.

Parameters:

a - the attribute

pool - the constant pool

Returns:

true iff the attribute is a local variable type table

get_attribute_name

public static java.lang.String get_attribute_name(org.apache.bcel.classfile.Attribute a,
                                                  org.apache.bcel.generic.ConstantPoolGen pool)

Deprecated.

Return the attribute name for the specified attribute.

Parameters:

a - the attribute

pool - the constant pool

Returns:

the attribute name for the specified attribute

is_main

public static boolean is_main(org.apache.bcel.generic.MethodGen mg)

Deprecated.

Returns whether or not this is a standard main method (static, name is 'main', and one argument of string array).

Parameters:

mg - the method to check

Returns:

true iff the method is a main method

type_to_classgetname

public static java.lang.String type_to_classgetname(org.apache.bcel.generic.Type type)

Deprecated.

Returns the Java class name, in the format of Class.getName(), that corresponds to type.

Parameters:

type - the type

Returns:

the Java classname that corresponds to type

type_to_class

public static java.lang.Class<?> type_to_class(org.apache.bcel.generic.Type type)

Deprecated.

Returns the class that corresponds to type.

Parameters:

type - the type

Returns:

the Java class that corresponds to type

postpendToArray

public static org.apache.bcel.generic.Type[] postpendToArray(org.apache.bcel.generic.Type[] types,
                                                             org.apache.bcel.generic.Type new_type)

Deprecated.

Returns a copy of the given type array, with new_type added to the end.

Parameters:

types - the array to extend

new_type - the element to add to the end of the array

Returns:

a new array, with new_type at the end

add_type

@Deprecated
public static org.apache.bcel.generic.Type[] add_type(org.apache.bcel.generic.Type[] types,
                                                                  org.apache.bcel.generic.Type new_type)

Deprecated. use postpendToArray(org.apache.bcel.generic.Type[], org.apache.bcel.generic.Type)

Returns a copy of the given type array, with new_type added to the end.

Parameters:

types - the array to extend

new_type - the element to add to the end of the array

Returns:

a new array, with new_type at the end

prependToArray

public static org.apache.bcel.generic.Type[] prependToArray(org.apache.bcel.generic.Type new_type,
                                                            org.apache.bcel.generic.Type[] types)

Deprecated.

Returns a copy of the given type array, with new_type inserted at the beginning.

Parameters:

types - the array to extend

new_type - the element to add to the beginning of the array

Returns:

a new array, with new_type at the beginning

insert_type

@Deprecated
public static org.apache.bcel.generic.Type[] insert_type(org.apache.bcel.generic.Type new_type,
                                                                     org.apache.bcel.generic.Type[] types)

Deprecated. use prependToArray(org.apache.bcel.generic.Type, org.apache.bcel.generic.Type[])

Returns a copy of the given type array, with new_type inserted at the beginning.

Parameters:

types - the array to extend

new_type - the element to add to the beginning of the array

Returns:

a new array, with new_type at the beginning

classname_to_type

public static org.apache.bcel.generic.Type classname_to_type(java.lang.String classname)

Deprecated.

Return the type corresponding to a given fully-qualified class name.

Parameters:

classname - the fully-qualified name of a class

Returns:

the type corresponding to the given class name