org.macroing.cel4j.java.binary.support

Class ClassFiles

java.lang.Object

org.macroing.cel4j.java.binary.support.ClassFiles

public final class ClassFiles
extends java.lang.Object

This class consists exclusively of static support methods for this library.

Since:

1.0.0

Author:

Jörgen Lundgren

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getAttributeInfoName(ClassFile classFile, AttributeInfo attributeInfo, CodeAttribute codeAttribute)
static java.util.List<ConstantUTF8Info>	getConstantUTF8InfosReferencedFromConstantClassInfos(ClassFile classFile) Returns a List with all ConstantUTF8Infos that are referenced from ConstantClassInfos in the constant_pool table of classFile.
static java.util.List<ConstantUTF8Info>	getConstantUTF8InfosReferencedFromConstantNameAndTypeInfos(ClassFile classFile) Returns a List with all ConstantUTF8Infos that are referenced from ConstantNameAndTypeInfos in the constant_pool table of classFile.
static java.util.Optional<FieldInfo>	getFieldInfoByName(ClassFile classFile, java.lang.String name) Returns the optional FieldInfo provided by classFile given name.
static java.lang.String	getInterfaceName(ClassFile classFile, int index)
static java.util.Optional<MethodInfo>	getMethodInfoByName(ClassFile classFile, java.lang.String name)
static boolean	isClassName(ClassFile classFile, ConstantUTF8Info constantUTF8Info) Returns true if, and only if, constantUTF8Info refers to the name of classFile, false otherwise.
static boolean	isConstantClassInfoPointingToNameIndex(ClassFile classFile, int index) Returns true if, and only if, at least one ConstantClassInfo in the constant_pool table of classFile has a name_index that points to index, false otherwise.
static boolean	isConstantNameAndTypeInfoPointingToDescriptorIndex(ClassFile classFile, int index) Returns true if, and only if, at least one ConstantNameAndTypeInfo in the constant_pool table of classFile has a descriptor_index that points to index, false otherwise.
static boolean	isFieldDescriptor(ClassFile classFile, ConstantUTF8Info constantUTF8Info) Returns true if, and only if, constantUTF8Info refers to the descriptor of a FieldInfo in classFile, false otherwise.
static boolean	isFieldInfoName(ClassFile classFile, ConstantUTF8Info constantUTF8Info) Returns true if, and only if, constantUTF8Info refers to the name of a FieldInfo in classFile, false otherwise.
static boolean	isMethodDescriptor(ClassFile classFile, ConstantUTF8Info constantUTF8Info) Returns true if, and only if, constantUTF8Info refers to the descriptor of a MethodInfo in classFile, false otherwise.
static boolean	isMethodInfoName(ClassFile classFile, ConstantUTF8Info constantUTF8Info) Returns true if, and only if, constantUTF8Info refers to the name of a MethodInfo in classFile, false otherwise.

Methods inherited from class java.lang.Object

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

Method Detail

getConstantUTF8InfosReferencedFromConstantClassInfos

public static java.util.List<ConstantUTF8Info> getConstantUTF8InfosReferencedFromConstantClassInfos(ClassFile classFile)

Returns a List with all ConstantUTF8Infos that are referenced from ConstantClassInfos in the constant_pool table of classFile.

If classFile is null, a NullPointerException will be thrown.

Parameters:

classFile - a ClassFile

Returns:

a List with all ConstantUTF8Infos that are referenced from ConstantClassInfos in the constant_pool table of classFile

Throws:

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

getConstantUTF8InfosReferencedFromConstantNameAndTypeInfos

public static java.util.List<ConstantUTF8Info> getConstantUTF8InfosReferencedFromConstantNameAndTypeInfos(ClassFile classFile)

Returns a List with all ConstantUTF8Infos that are referenced from ConstantNameAndTypeInfos in the constant_pool table of classFile.

If classFile is null, a NullPointerException will be thrown.

Parameters:

classFile - a ClassFile

Returns:

a List with all ConstantUTF8Infos that are referenced from ConstantNameAndTypeInfos in the constant_pool table of classFile

Throws:

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

getFieldInfoByName

public static java.util.Optional<FieldInfo> getFieldInfoByName(ClassFile classFile,
                                                               java.lang.String name)

Returns the optional FieldInfo provided by classFile given name.

If either classFile or name are null, a NullPointerException will be thrown.

Parameters:

classFile - a ClassFile

name - the name of the FieldInfo to get

Returns:

the optional FieldInfo provided by classFile given name

Throws:

java.lang.NullPointerException - thrown if, and only if, either classFile or name are null

getMethodInfoByName

public static java.util.Optional<MethodInfo> getMethodInfoByName(ClassFile classFile,
                                                                 java.lang.String name)

getAttributeInfoName

public static java.lang.String getAttributeInfoName(ClassFile classFile,
                                                    AttributeInfo attributeInfo,
                                                    CodeAttribute codeAttribute)

getInterfaceName

public static java.lang.String getInterfaceName(ClassFile classFile,
                                                int index)

isClassName

public static boolean isClassName(ClassFile classFile,
                                  ConstantUTF8Info constantUTF8Info)

Returns true if, and only if, constantUTF8Info refers to the name of classFile, false otherwise.

If either classFile or constantUTF8Info are null, a NullPointerException will be thrown.

Parameters:

classFile - a ClassFile

constantUTF8Info - a ConstantUTF8Info

Returns:

true if, and only if, constantUTF8Info refers to the name of a classFile, false otherwise

Throws:

java.lang.NullPointerException - thrown if, and only if, either classFile or constantUTF8Info are null

isConstantClassInfoPointingToNameIndex

public static boolean isConstantClassInfoPointingToNameIndex(ClassFile classFile,
                                                             int index)

Returns true if, and only if, at least one ConstantClassInfo in the constant_pool table of classFile has a name_index that points to index, false otherwise.

If index does not point to a valid index in the constant_pool table of classFile, an IllegalArgumentException will be thrown.

If classFile is null, a NullPointerException will be thrown.

Parameters:

classFile - a ClassFile

index - an index into the constant_pool table of classFile

Returns:

true if, and only if, at least one ConstantClassInfo in the constant_pool table of classFile has a name_index that points to index, false otherwise

Throws:

java.lang.IllegalArgumentException - thrown if, and only if, index does not point to a valid index in the constant_pool table of classFile

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

isConstantNameAndTypeInfoPointingToDescriptorIndex

public static boolean isConstantNameAndTypeInfoPointingToDescriptorIndex(ClassFile classFile,
                                                                         int index)

Returns true if, and only if, at least one ConstantNameAndTypeInfo in the constant_pool table of classFile has a descriptor_index that points to index, false otherwise.

If index does not point to a valid index in the constant_pool table of classFile, an IllegalArgumentException will be thrown.

If classFile is null, a NullPointerException will be thrown.

Parameters:

classFile - a ClassFile

index - an index into the constant_pool table of classFile

Returns:

true if, and only if, at least one ConstantNameAndTypeInfo in the constant_pool table of classFile has a descriptor_index that points to index, false otherwise

Throws:

java.lang.IllegalArgumentException - thrown if, and only if, index does not point to a valid index in the constant_pool table of classFile

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

isFieldDescriptor

public static boolean isFieldDescriptor(ClassFile classFile,
                                        ConstantUTF8Info constantUTF8Info)

Returns true if, and only if, constantUTF8Info refers to the descriptor of a FieldInfo in classFile, false otherwise.

If either classFile or constantUTF8Info are null, a NullPointerException will be thrown.

Parameters:

classFile - the ClassFile that contains constantUTF8Info

constantUTF8Info - the ConstantUTF8Info that should refer to the descriptor of a FieldInfo in classFile

Returns:

true if, and only if, constantUTF8Info refers to the descriptor of a FieldInfo in classFile, false otherwise

Throws:

java.lang.NullPointerException - thrown if, and only if, either classFile or constantUTF8Info are null

isFieldInfoName

public static boolean isFieldInfoName(ClassFile classFile,
                                      ConstantUTF8Info constantUTF8Info)

Returns true if, and only if, constantUTF8Info refers to the name of a FieldInfo in classFile, false otherwise.

If either classFile or constantUTF8Info are null, a NullPointerException will be thrown.

Parameters:

classFile - the ClassFile that contains constantUTF8Info

constantUTF8Info - the ConstantUTF8Info that should refer to the name of a FieldInfo in classFile

Returns:

true if, and only if, constantUTF8Info refers to the name of a FieldInfo in classFile, false otherwise

Throws:

java.lang.NullPointerException - thrown if, and only if, either classFile or constantUTF8Info are null

isMethodDescriptor

public static boolean isMethodDescriptor(ClassFile classFile,
                                         ConstantUTF8Info constantUTF8Info)

Returns true if, and only if, constantUTF8Info refers to the descriptor of a MethodInfo in classFile, false otherwise.

If either classFile or constantUTF8Info are null, a NullPointerException will be thrown.

Parameters:

classFile - the ClassFile that contains constantUTF8Info

constantUTF8Info - the ConstantUTF8Info that should refer to the descriptor of a MethodInfo in classFile

Returns:

true if, and only if, constantUTF8Info refers to the descriptor of a MethodInfo in classFile, false otherwise

Throws:

java.lang.NullPointerException - thrown if, and only if, either classFile or constantUTF8Info are null

isMethodInfoName

public static boolean isMethodInfoName(ClassFile classFile,
                                       ConstantUTF8Info constantUTF8Info)

Returns true if, and only if, constantUTF8Info refers to the name of a MethodInfo in classFile, false otherwise.

If either classFile or constantUTF8Info are null, a NullPointerException will be thrown.

Parameters:

classFile - the ClassFile that contains constantUTF8Info

constantUTF8Info - the ConstantUTF8Info that should refer to the name of a MethodInfo in classFile

Returns:

true if, and only if, constantUTF8Info refers to the name of a MethodInfo in classFile, false otherwise

Throws:

java.lang.NullPointerException - thrown if, and only if, either classFile or constantUTF8Info are null