com.spazedog.lib.reflecttools

Class ReflectClass

java.lang.Object

com.spazedog.lib.reflecttools.ReflectObject<java.lang.Class<?>>

com.spazedog.lib.reflecttools.ReflectClass

public class ReflectClass
extends ReflectObject<java.lang.Class<?>>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ReflectClass.OnClassReceiverListener
static class	ReflectClass.ReflectClassException

Method Summary

Methods

Modifier and Type	Method and Description
ReflectClass	bindInterface(IBinder binder)
ReflectClass	bindInterface(java.lang.String service)
int	bridge(MethodBridge callback) Add a hook to all Constructor's of this class
int	bridge(java.lang.String methodName, MethodBridge callback) Add a hook to all Method's of this class with a specific name
static java.lang.Class<?>	findClass(java.lang.String className)
static java.lang.Class<?>	findClass(java.lang.String className, java.lang.ClassLoader loader) This is the same as using Class.forName(String, boolean, ClassLoader) only that this method handles a few issues that some times occurs when parsing a ClassLoader.
static java.lang.ClassLoader	findClassLoader() Finds the best suited ClassLoader.
ReflectConstructor	findConstructor(java.lang.Object... parameterTypes)
ReflectConstructor	findConstructor(ReflectMember.Match match, java.lang.Object... parameterTypes) Search for a Constructor within this class.
ReflectConstructor	findConstructor(ReflectMember.Match match, ReflectParameterTypes parameterTypes) Search for a Constructor within this class.
ReflectField	findField(java.lang.String fieldName)
ReflectField	findField(java.lang.String fieldName, ReflectMember.Match match) Search for a Field within this class.
ReflectMethod	findMethod(java.lang.String methodName, java.lang.Object... parameterTypes)
ReflectMethod	findMethod(java.lang.String methodName, ReflectMember.Match match, java.lang.Object... parameterTypes) Search for a Method within this class.
ReflectMethod	findMethod(java.lang.String methodName, ReflectMember.Match match, ReflectParameterTypes parameterTypes) Search for a Method within this class.
static ReflectClass	fromClass(java.lang.Class<?> clazz) Attach a Class to a new instance of ReflectClass
static ReflectClass	fromName(java.lang.String className)
static ReflectClass	fromName(java.lang.String className, java.lang.ClassLoader loader) Find a Class based on class name and return a new ReflectClass instance with the located Class attached to it
static ReflectClass	fromReceiver(java.lang.Object receiver) Attach the Class of a receiver to a new instance of ReflectClass and add the receiver itself to be used with this instance whenever invoking members from it
java.lang.Object	getFieldValue(java.lang.String fieldName)
java.lang.Object	getFieldValue(java.lang.String fieldName, ReflectMember.Match match) This is a shortcut that will both search for and get the value from a Field
ReflectClass	getNested(java.lang.String simpleName) Returns a new ReflectClass instance pointing at a nested class within the current class.
java.lang.Class<?>	getNestedClass(java.lang.String simpleName) Locates a nested class based on it's simple name.
ReflectClass	getNestedInstantiated(java.lang.String simpleName, java.lang.Object... arguments) This is the same as getNested(String) only this one will also instantiate the nested class.
java.lang.Class<?>	getObject() Returns the object T attached to this object
ReflectClass	getParent() This will return a new ReflectClass of the parent class.
java.lang.Class<?>	getParentClass() Returns the parent Class or NULL if the current class is not a nested class
java.lang.Object	getParentReceiver() Returns the receiver of the parent class or NULL if the current class does not have a receiver or if the current class is not a nested instance.
java.lang.Object	getReceiver() Returns the receiver accociated with this object
static ReflectClass	instantiateClass(java.lang.Class<?> clazz, java.lang.Object... arguments)
static ReflectClass	instantiateName(java.lang.String className, java.lang.ClassLoader loader, java.lang.Object... arguments) This is the same as fromName(String, ClassLoader), only this method will also instantiate the class using the constructor matching the parsed arguments.
static ReflectClass	instantiateName(java.lang.String className, java.lang.Object... arguments)
ReflectClass	invokeConstructor(java.lang.Object... arguments)
ReflectClass	invokeConstructor(ReflectMember.Match match, java.lang.Object... arguments) This is a shortcut that will both search for and invoke a Constructor based on the arguments parsed.
java.lang.Object	invokeMethod(java.lang.String methodName, java.lang.Object... arguments)
java.lang.Object	invokeMethod(java.lang.String methodName, ReflectMember.Match match, java.lang.Object... arguments) This is a shortcut that will both search for and invoke a Method based on the arguments parsed.
boolean	isAbstract() Whether or not the class was declared abstract
boolean	isFinal() Whether or not the class was declared final
boolean	isInterface() Whether or not the class is an interface
boolean	isNested() Whether or not the class is a nested class
boolean	isPrivate() Whether or not the class was declared private
boolean	isProtected() Whether or not the class was declared protected
boolean	isPublic() Whether or not the class was declared public
boolean	isStatic() Whether or not the class was declared static
void	setFieldValue(java.lang.String fieldName, java.lang.Object value)
void	setFieldValue(java.lang.String fieldName, ReflectMember.Match match, java.lang.Object value) This is a shortcut that will both search for and change the value of a Field
void	setReceiver(java.lang.Object receiver) Set the receiver used when invoking members belonging to it
void	setReceiverListener(ReflectClass.OnClassReceiverListener listener)

Methods inherited from class java.lang.Object

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

Method Detail

findClassLoader

public static java.lang.ClassLoader findClassLoader()

Finds the best suited ClassLoader. This method also handles special cases in Android >= Lollipop where the Boot ClassLoader cannot access specific internal packages.

findClass

public static java.lang.Class<?> findClass(java.lang.String className)
                                    throws ReflectClass.ReflectClassException

Throws:

ReflectClass.ReflectClassException

See Also:

findClass(String, ClassLoader)

findClass

public static java.lang.Class<?> findClass(java.lang.String className,
                           java.lang.ClassLoader loader)
                                    throws ReflectClass.ReflectClassException

This is the same as using Class.forName(String, boolean, ClassLoader) only that this method handles a few issues that some times occurs when parsing a ClassLoader. This method also stores an internal cache that speed things up if the same class is searched multiple times.

Parameters:

className - Full name of the class to find

loader - A ClassLoader object. If this is NULL then findClassLoader() is used instead

Throws:

ReflectClass.ReflectClassException - This is thrown if the class could not be located

instantiateName

public static ReflectClass instantiateName(java.lang.String className,
                           java.lang.Object... arguments)
                                    throws ReflectClass.ReflectClassException,
                                           ReflectMember.ReflectMemberException

Throws:

ReflectClass.ReflectClassException

ReflectMember.ReflectMemberException

See Also:

instantiateName(String, ClassLoader, Object...)

instantiateName

public static ReflectClass instantiateName(java.lang.String className,
                           java.lang.ClassLoader loader,
                           java.lang.Object... arguments)
                                    throws ReflectClass.ReflectClassException,
                                           ReflectMember.ReflectMemberException

This is the same as fromName(String, ClassLoader), only this method will also instantiate the class using the constructor matching the parsed arguments. It will search for a constructor using ReflectMember.Match.BEST based on the Class types of the arguments. It will then invoke the constructor and add the receiver to this class's receiver. For more precise constructor search, manually invoke one using #findConstructor(Match, ReflectParameterTypes)

Parameters:

className - Full name of the class to find

loader - A ClassLoader object. If this is NULL then findClassLoader() is used instead

arguments - Arguments that should be parsed to the constructor. The constructor will be found using the types of these arguments using a best match.

Throws:

ReflectClass.ReflectClassException - Thrown if the class could not be found

ReflectMember.ReflectMemberException - Thrown if the constructor could not be found or failed when being invoked

instantiateClass

public static ReflectClass instantiateClass(java.lang.Class<?> clazz,
                            java.lang.Object... arguments)
                                     throws ReflectClass.ReflectClassException,
                                            ReflectMember.ReflectMemberException

Throws:

ReflectClass.ReflectClassException

ReflectMember.ReflectMemberException

See Also:

instantiateName(String, ClassLoader, Object...)

fromName

public static ReflectClass fromName(java.lang.String className)
                             throws ReflectClass.ReflectClassException

Throws:

ReflectClass.ReflectClassException

See Also:

fromName(String, ClassLoader)

fromName

public static ReflectClass fromName(java.lang.String className,
                    java.lang.ClassLoader loader)
                             throws ReflectClass.ReflectClassException

Find a Class based on class name and return a new ReflectClass instance with the located Class attached to it

Parameters:

className - Full name of the class to find

loader - A ClassLoader object. If this is NULL then findClassLoader() is used instead

Throws:

ReflectClass.ReflectClassException - This is thrown if the class could not be located

fromClass

public static ReflectClass fromClass(java.lang.Class<?> clazz)
                              throws ReflectClass.ReflectClassException

Attach a Class to a new instance of ReflectClass

Parameters:

clazz - The Class to attach to this instance

Throws:

ReflectClass.ReflectClassException

fromReceiver

public static ReflectClass fromReceiver(java.lang.Object receiver)
                                 throws ReflectClass.ReflectClassException

Attach the Class of a receiver to a new instance of ReflectClass and add the receiver itself to be used with this instance whenever invoking members from it

Parameters:

receiver - A class instance

Throws:

ReflectClass.ReflectClassException

See Also:

setReceiver(Object)

setReceiverListener

public void setReceiverListener(ReflectClass.OnClassReceiverListener listener)

setReceiver

public void setReceiver(java.lang.Object receiver)

Set the receiver used when invoking members belonging to it

Parameters:

receiver - A class instance of this class object

getReceiver

public java.lang.Object getReceiver()

Returns the receiver accociated with this object

Specified by:

getReceiver in class ReflectObject<java.lang.Class<?>>

getObject

public java.lang.Class<?> getObject()

Returns the object T attached to this object

Specified by:

getObject in class ReflectObject<java.lang.Class<?>>

isStatic

public boolean isStatic()

Whether or not the class was declared static

isPrivate

public boolean isPrivate()

Whether or not the class was declared private

isProtected

public boolean isProtected()

Whether or not the class was declared protected

isPublic

public boolean isPublic()

Whether or not the class was declared public

isAbstract

public boolean isAbstract()

Whether or not the class was declared abstract

isInterface

public boolean isInterface()

Whether or not the class is an interface

isFinal

public boolean isFinal()

Whether or not the class was declared final

isNested

public boolean isNested()

Whether or not the class is a nested class

getParent

public ReflectClass getParent()

This will return a new ReflectClass of the parent class. If this instance has a receiver then the parent receiver will be added as well.

NULL is returned if this is not a nested class.

getNested

public ReflectClass getNested(java.lang.String simpleName)

Returns a new ReflectClass instance pointing at a nested class within the current class. If the nested class is not declared as static, it will get a reference of the current receiver which will allow you to instantiate it.

NULL is returned if no nested class was found

Parameters:

simpleName - The name of the nested class. This should be the simple name

getNestedInstantiated

public ReflectClass getNestedInstantiated(java.lang.String simpleName,
                                 java.lang.Object... arguments)
                                   throws ReflectMember.ReflectMemberException

This is the same as getNested(String) only this one will also instantiate the nested class. It will search for a constructor based on the parsed arguments using a best match. If the nested class is not static, it will instantiate the class based on it's parent receiver.

Parameters:

simpleName - The name of the nested class. This should be the simple name

arguments - Arguments to be parsed to the constructor

Throws:

ReflectMember.ReflectMemberException - Thrown if a matching constructor could not be found or if it failed being invoked

getParentReceiver

public java.lang.Object getParentReceiver()

Returns the receiver of the parent class or NULL if the current class does not have a receiver or if the current class is not a nested instance.

getParentClass

public java.lang.Class<?> getParentClass()

Returns the parent Class or NULL if the current class is not a nested class

getNestedClass

public java.lang.Class<?> getNestedClass(java.lang.String simpleName)

Locates a nested class based on it's simple name. Returns NULL if no nested class was found.

This method will also search super classes if the current class has no nested class matching the name.

invokeConstructor

public ReflectClass invokeConstructor(java.lang.Object... arguments)
                               throws ReflectMember.ReflectMemberException,
                                      ReflectParameterTypes.ReflectParameterException

Throws:

ReflectMember.ReflectMemberException

ReflectParameterTypes.ReflectParameterException

See Also:

#invokeConstructor(Match, Object...)

invokeConstructor

public ReflectClass invokeConstructor(ReflectMember.Match match,
                             java.lang.Object... arguments)
                               throws ReflectMember.ReflectMemberException,
                                      ReflectParameterTypes.ReflectParameterException

This is a shortcut that will both search for and invoke a Constructor based on the arguments parsed.

Parameters:

match - How deep to search for the Constructor

arguments - Arguments that should be parsed to the Constructor

Throws:

ReflectMember.ReflectMemberException - Thrown if the Constructor could not be found or invoked

ReflectParameterTypes.ReflectParameterException - Thrown if an error occurs while getting the types of the arguments

See Also:

#findConstructor(Match, Object...), ReflectConstructor#invoke(Result, Object...)

findConstructor

public ReflectConstructor findConstructor(java.lang.Object... parameterTypes)
                                   throws ReflectMember.ReflectMemberException,
                                          ReflectParameterTypes.ReflectParameterException

Throws:

ReflectMember.ReflectMemberException

ReflectParameterTypes.ReflectParameterException

See Also:

#findConstructor(Match, Object...)

findConstructor

public ReflectConstructor findConstructor(ReflectMember.Match match,
                                 java.lang.Object... parameterTypes)
                                   throws ReflectMember.ReflectMemberException,
                                          ReflectParameterTypes.ReflectParameterException

Search for a Constructor within this class.

Parameters:

match - How deep to search for the Constructor

parameterTypes - The Class types of the arguments that should match the Constructor. This can also be String representing the whole Class path which will be converted into a Class type

Throws:

ReflectMember.ReflectMemberException - Thrown if the Constructor could not be found

ReflectParameterTypes.ReflectParameterException - Thrown if an error occurs while converting String types into Class types

See Also:

#findConstructor(Match, ReflectParameterTypes)

findConstructor

public ReflectConstructor findConstructor(ReflectMember.Match match,
                                 ReflectParameterTypes parameterTypes)
                                   throws ReflectMember.ReflectMemberException

Search for a Constructor within this class.

Parameters:

match - How deep to search for the Constructor

parameterTypes - A ReflectParameterTypes instance containing the parameter types that should match the Constructor

Throws:

ReflectMember.ReflectMemberException - Thrown if the Constructor could not be found

See Also:

#findConstructor(Match, Object...)

invokeMethod

public java.lang.Object invokeMethod(java.lang.String methodName,
                            java.lang.Object... arguments)
                              throws ReflectMember.ReflectMemberException,
                                     ReflectParameterTypes.ReflectParameterException

Throws:

ReflectMember.ReflectMemberException

ReflectParameterTypes.ReflectParameterException

See Also:

#invokeMethod(String, Match, Object...)

invokeMethod

public java.lang.Object invokeMethod(java.lang.String methodName,
                            ReflectMember.Match match,
                            java.lang.Object... arguments)
                              throws ReflectMember.ReflectMemberException,
                                     ReflectParameterTypes.ReflectParameterException

This is a shortcut that will both search for and invoke a Method based on the arguments parsed.

Parameters:

methodName - The name of the Method

match - How deep to search for the Method

arguments - Arguments that should be parsed to the Method

Throws:

ReflectMember.ReflectMemberException - Thrown if the Method could not be found or invoked

ReflectParameterTypes.ReflectParameterException - Thrown if an error occurs while getting the types of the arguments

See Also:

#findMethod(String, Match, Object...), ReflectMethod#invoke(Result, Object...)

findMethod

public ReflectMethod findMethod(java.lang.String methodName,
                       java.lang.Object... parameterTypes)
                         throws ReflectMember.ReflectMemberException,
                                ReflectParameterTypes.ReflectParameterException

Throws:

ReflectMember.ReflectMemberException

ReflectParameterTypes.ReflectParameterException

See Also:

#findMethod(String, Match, Object...)

findMethod

public ReflectMethod findMethod(java.lang.String methodName,
                       ReflectMember.Match match,
                       java.lang.Object... parameterTypes)
                         throws ReflectMember.ReflectMemberException,
                                ReflectParameterTypes.ReflectParameterException

Search for a Method within this class.

Parameters:

methodName - The name of the Method

match - How deep to search for the Method

parameterTypes - The Class types of the arguments that should match the Method. This can also be String representing the whole Class path which will be converted into a Class type

Throws:

ReflectMember.ReflectMemberException - Thrown if the Method could not be found

ReflectParameterTypes.ReflectParameterException - Thrown if an error occurs while converting String types into Class types

See Also:

#findMethod(String, Match, ReflectParameterTypes)

findMethod

public ReflectMethod findMethod(java.lang.String methodName,
                       ReflectMember.Match match,
                       ReflectParameterTypes parameterTypes)
                         throws ReflectMember.ReflectMemberException

Search for a Method within this class.

Parameters:

methodName - The name of the Method

match - How deep to search for the Method

parameterTypes - A ReflectParameterTypes instance containing the parameter types that should match the Method

Throws:

ReflectMember.ReflectMemberException - Thrown if the Method could not be found

See Also:

#findMethod(String, Match, Object...)

getFieldValue

public java.lang.Object getFieldValue(java.lang.String fieldName)
                               throws ReflectMember.ReflectMemberException

Throws:

ReflectMember.ReflectMemberException

See Also:

#getFieldValue(String, Match)

getFieldValue

public java.lang.Object getFieldValue(java.lang.String fieldName,
                             ReflectMember.Match match)
                               throws ReflectMember.ReflectMemberException

This is a shortcut that will both search for and get the value from a Field

Parameters:

fieldName - Name of the Field

match - How deep to search for the Field

Throws:

ReflectMember.ReflectMemberException - Thrown if the Field could not be found or invoked

See Also:

#findField(String, Match), ReflectField#getValue(Result)

setFieldValue

public void setFieldValue(java.lang.String fieldName,
                 java.lang.Object value)
                   throws ReflectMember.ReflectMemberException

Throws:

ReflectMember.ReflectMemberException

See Also:

#setFieldValue(String, Match, Object)

setFieldValue

public void setFieldValue(java.lang.String fieldName,
                 ReflectMember.Match match,
                 java.lang.Object value)
                   throws ReflectMember.ReflectMemberException

This is a shortcut that will both search for and change the value of a Field

Parameters:

fieldName - Name of the Field

match - How deep to search for the Field

value - The value to add to the fieldName

Throws:

ReflectMember.ReflectMemberException - Thrown if the Field could not be found or changed

See Also:

#findField(String, Match), ReflectField.setValue(Object)

findField

public ReflectField findField(java.lang.String fieldName)
                       throws ReflectMember.ReflectMemberException

Throws:

ReflectMember.ReflectMemberException

See Also:

#findField(String, Match)

findField

public ReflectField findField(java.lang.String fieldName,
                     ReflectMember.Match match)
                       throws ReflectMember.ReflectMemberException

Search for a Field within this class.

Parameters:

fieldName - The name of the Field

match - How deep to search for the Field

Throws:

ReflectMember.ReflectMemberException - Thrown if the Field could not be found

bridge

public int bridge(MethodBridge callback)
           throws ReflectClass.ReflectClassException

Add a hook to all Constructor's of this class

Parameters:

callback - A callback instance that will be called whenever someone calls one of the Constructor's

Returns:

The number of Constructor's that was affected

Throws:

ReflectClass.ReflectClassException - Thrown if no Constructor's could be found or if it was not possible to add the hook due to missing injection systems, such as Xposed Framework and Cydia Substrate

bridge

public int bridge(java.lang.String methodName,
         MethodBridge callback)
           throws ReflectClass.ReflectClassException

Add a hook to all Method's of this class with a specific name

Parameters:

methodName - The name of the Method's

callback - A callback instance that will be called whenever someone calls one of the Method's

Returns:

The number of Method's that was affected

Throws:

ReflectClass.ReflectClassException - Thrown if no Method's could be found matching the name or if it was not possible to add the hook due to missing injection systems, such as Xposed Framework and Cydia Substrate

bindInterface

public ReflectClass bindInterface(java.lang.String service)
                           throws ReflectMember.ReflectMemberException,
                                  ReflectParameterTypes.ReflectParameterException

Throws:

ReflectMember.ReflectMemberException

ReflectParameterTypes.ReflectParameterException

bindInterface

public ReflectClass bindInterface(IBinder binder)
                           throws ReflectMember.ReflectMemberException,
                                  ReflectParameterTypes.ReflectParameterException

Parameters:

binder - The IBinder to bind to the interface

Returns:

Itself with the IBinder Receiver

Throws:

ReflectMember.ReflectMemberException - Thrown if using an invalid interface

ReflectParameterTypes.ReflectParameterException - Thrown if an IBinder is NULL

See Also:

bindInterface(String)