mockit

Class Deencapsulation

java.lang.Object

mockit.Deencapsulation

public final class Deencapsulation
extends Object

Provides utility methods that enable access to ("de-encapsulate") otherwise non-accessible fields, methods, and constructors.

See Also:

getField(Object, String), setField(Object, String, Object), invoke(Object, String, Object...), newInstance(String, Object...), Tutorial (general), Tutorial (expectations)

Method Summary

Modifier and Type	Method and Description
static <T> T	getField(Class<?> classWithStaticField, Class<T> fieldType) Gets the value of a non-accessible static field defined in a given class, assuming there is only one field declared in the given class whose type can receive values of the specified field type.
static <T> T	getField(Class<?> classWithStaticField, String fieldName) Gets the value of a non-accessible static field defined in a given class.
static <T> T	getField(Object objectWithField, Class<T> fieldType) Gets the value of a non-accessible (eg private) field from a given object, assuming there is only one field declared in the class of the given object whose type can receive values of the specified field type.
static <T> T	getField(Object objectWithField, String fieldName) Gets the value of a non-accessible (eg private) field from a given object.
static <T> T	invoke(Class<?> classWithStaticMethod, String methodName, Class<?>[] parameterTypes, Object... methodArgs) Invokes a non-accessible (eg private) static method with the given arguments.
static <T> T	invoke(Class<?> classWithStaticMethod, String methodName, Object... nonNullArgs) Invokes a non-accessible (eg private) static method with the given arguments.
static <T> T	invoke(Object objectWithMethod, String methodName, Class<?>[] parameterTypes, Object... methodArgs) Invokes a non-accessible (eg private) instance method from a given class with the given arguments.
static <T> T	invoke(Object objectWithMethod, String methodName, Object... nonNullArgs) Invokes a non-accessible (eg private) instance method from a given class with the given arguments.
static <T> T	invoke(String classWithStaticMethod, String methodName, Object... nonNullArgs) Invokes a non-accessible (eg private) static method with the given arguments.
static <T> T	newInnerInstance(Class<? extends T> innerClassToInstantiate, Object outerClassInstance, Object... nonNullArgs) The same as newInstance(String, Class[], Object...), but for instantiating an inner class of some other class, and where all other (if any) initialization arguments are known to be non-null.
static <T> T	newInnerInstance(String innerClassSimpleName, Object outerClassInstance, Object... nonNullArgs) The same as newInstance(String, Class[], Object...), but for instantiating an inner non-accessible class of some other class, and where all other (if any) initialization arguments are known to be non-null.
static <T> T	newInstance(Class<? extends T> classToInstantiate, Class<?>[] parameterTypes, Object... initArgs) Creates a new instance of a given class, invoking the constructor which has the specified parameter types.
static <T> T	newInstance(Class<? extends T> classToInstantiate, Object... nonNullArgs) Creates a new instance of a given class, invoking the constructor which has parameters matching the number, order, and types of the given non-null arguments.
static <T> T	newInstance(String className, Class<?>[] parameterTypes, Object... initArgs) Creates a new instance of a given non-accessible class, invoking the constructor which has the specified parameter types.
static <T> T	newInstance(String className, Object... nonNullArgs) Creates a new instance of a given non-accessible class, invoking the constructor which has parameters matching the number, order, and types of the given non-null arguments.
static <T> T	newUninitializedInstance(Class<? extends T> classToInstantiate) Creates a new instance of a given class, without invoking any constructor.
static void	setField(Class<?> classWithStaticField, Object fieldValue) Sets the value of a non-accessible static field on a given class.
static void	setField(Class<?> classWithStaticField, String fieldName, Object fieldValue) Sets the value of a non-accessible static field on a given class.
static void	setField(Object objectWithField, Object fieldValue) Sets the value of a non-accessible field on a given object.
static void	setField(Object objectWithField, String fieldName, Object fieldValue) Sets the value of a non-accessible field on a given object.

Methods inherited from class java.lang.Object

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

Method Detail

getField

public static <T> T getField(Class<?> classWithStaticField,
                             Class<T> fieldType)

Gets the value of a non-accessible static field defined in a given class, assuming there is only one field declared in the given class whose type can receive values of the specified field type.

Type Parameters:

T - interface or class type to which the returned value should be assignable

Parameters:

classWithStaticField - the class from which to get the field value

fieldType - the declared type of the field, or a sub-type of the declared field type

Throws:

IllegalArgumentException - if either the desired field is not found, or more than one is

See Also:

getField(Class, String), getField(Object, Class), setField(Class, Object)

getField

public static <T> T getField(Class<?> classWithStaticField,
                             String fieldName)

Gets the value of a non-accessible static field defined in a given class.

Type Parameters:

T - interface or class type to which the returned value should be assignable

Parameters:

classWithStaticField - the class from which to get the field value

fieldName - the name of the static field to get

Throws:

IllegalArgumentException - if the desired field is not found

See Also:

getField(Class, Class), getField(Object, String), setField(Class, String, Object)

getField

public static <T> T getField(Object objectWithField,
                             Class<T> fieldType)

Gets the value of a non-accessible (eg private) field from a given object, assuming there is only one field declared in the class of the given object whose type can receive values of the specified field type.

Parameters:

objectWithField - the instance from which to get the field value

fieldType - the declared type of the field, or a sub-type of the declared field type

Throws:

IllegalArgumentException - if either the desired field is not found, or more than one is

See Also:

getField(Object, String), getField(Class, String), setField(Object, Object)

getField

public static <T> T getField(Object objectWithField,
                             String fieldName)

Gets the value of a non-accessible (eg private) field from a given object.

Type Parameters:

T - interface or class type to which the returned value should be assignable

Parameters:

objectWithField - the instance from which to get the field value

fieldName - the name of the field to get

Throws:

IllegalArgumentException - if the desired field is not found

See Also:

getField(Object, Class), getField(Class, String), setField(Object, String, Object)

invoke

public static <T> T invoke(Class<?> classWithStaticMethod,
                           String methodName,
                           Class<?>[] parameterTypes,
                           Object... methodArgs)

Invokes a non-accessible (eg private) static method with the given arguments.

Type Parameters:

T - type to which the returned value should be assignable

Parameters:

classWithStaticMethod - the class on which the invocation is to be done

methodName - the name of the static method to invoke

parameterTypes - the types of the parameters as declared in the desired method

methodArgs - zero or more parameter values for the invocation

Returns:

the return value from the invoked method

See Also:

invoke(String, String, Object...)

invoke

public static <T> T invoke(Class<?> classWithStaticMethod,
                           String methodName,
                           Object... nonNullArgs)

Invokes a non-accessible (eg private) static method with the given arguments.

Type Parameters:

T - type to which the returned value should be assignable

Parameters:

classWithStaticMethod - the class on which the invocation is to be done

methodName - the name of the static method to invoke

nonNullArgs - zero or more non-null parameter values for the invocation; if a null value needs to be passed, the Class object for the corresponding parameter type must be passed instead

Returns:

the return value from the invoked method

Throws:

IllegalArgumentException - if a null reference was provided for a parameter

See Also:

invoke(String, String, Object...)

invoke

public static <T> T invoke(Object objectWithMethod,
                           String methodName,
                           Class<?>[] parameterTypes,
                           Object... methodArgs)

Invokes a non-accessible (eg private) instance method from a given class with the given arguments.

Type Parameters:

T - type to which the returned value should be assignable

Parameters:

objectWithMethod - the instance on which the invocation is to be done

methodName - the name of the method to invoke

parameterTypes - the types of the parameters as declared in the desired method

methodArgs - zero or more parameter values for the invocation

Returns:

the return value from the invoked method

See Also:

invoke(Class, String, Object...)

invoke

public static <T> T invoke(Object objectWithMethod,
                           String methodName,
                           Object... nonNullArgs)

Invokes a non-accessible (eg private) instance method from a given class with the given arguments.

Type Parameters:

T - type to which the returned value should be assignable

Parameters:

objectWithMethod - the instance on which the invocation is to be done

methodName - the name of the method to invoke

nonNullArgs - zero or more non-null parameter values for the invocation; if a null value needs to be passed, the Class object for the corresponding parameter type must be passed instead

Returns:

the return value from the invoked method

Throws:

IllegalArgumentException - if a null reference was provided for a parameter

See Also:

invoke(Class, String, Object...)

invoke

public static <T> T invoke(String classWithStaticMethod,
                           String methodName,
                           Object... nonNullArgs)

Invokes a non-accessible (eg private) static method with the given arguments.

Type Parameters:

T - type to which the returned value should be assignable

Parameters:

classWithStaticMethod - the (fully qualified) name of the class on which the invocation is to be done; must not be null

methodName - the name of the static method to invoke

nonNullArgs - zero or more non-null parameter values for the invocation; if a null value needs to be passed, the Class object for the corresponding parameter type must be passed instead

Returns:

the return value from the invoked method

Throws:

IllegalArgumentException - if a null reference was provided for a parameter

See Also:

invoke(Class, String, Object...)

newInnerInstance

public static <T> T newInnerInstance(Class<? extends T> innerClassToInstantiate,
                                     Object outerClassInstance,
                                     Object... nonNullArgs)

The same as newInstance(String, Class[], Object...), but for instantiating an inner class of some other class, and where all other (if any) initialization arguments are known to be non-null.

Type Parameters:

T - type to which the returned instance should be assignable

Parameters:

innerClassToInstantiate - the inner class to be instantiated

outerClassInstance - the outer class instance to which the inner class instance will belong

nonNullArgs - zero or more non-null parameter values for the invocation; if a null value needs to be passed, the Class object for the corresponding parameter type must be passed instead

Returns:

a newly created instance of the specified inner class, initialized with the given arguments

Throws:

IllegalArgumentException - if a null reference was provided for a parameter

See Also:

newInnerInstance(String, Object, Object...)

newInnerInstance

public static <T> T newInnerInstance(String innerClassSimpleName,
                                     Object outerClassInstance,
                                     Object... nonNullArgs)

The same as newInstance(String, Class[], Object...), but for instantiating an inner non-accessible class of some other class, and where all other (if any) initialization arguments are known to be non-null.

Type Parameters:

T - type to which the returned instance should be assignable

Parameters:

innerClassSimpleName - the inner class simple name, that is, the part after the "$" character in its full name

outerClassInstance - the outer class instance to which the inner class instance will belong

nonNullArgs - zero or more non-null parameter values for the invocation; if a null value needs to be passed, the Class object for the corresponding parameter type must be passed instead

Returns:

a newly created instance of the specified inner class, initialized with the given arguments

Throws:

IllegalArgumentException - if a null reference was provided for a parameter

See Also:

newInnerInstance(Class, Object, Object...)

newInstance

public static <T> T newInstance(Class<? extends T> classToInstantiate,
                                Class<?>[] parameterTypes,
                                Object... initArgs)

Creates a new instance of a given class, invoking the constructor which has the specified parameter types.

Type Parameters:

T - type to which the returned instance should be assignable

Parameters:

classToInstantiate - the class to be instantiated

parameterTypes - the formal parameter types for the desired constructor, possibly empty

initArgs - the invocation arguments for the constructor, which must be consistent with the specified parameter types

Returns:

a newly created instance of the specified class, initialized through the specified constructor and arguments

See Also:

newInstance(Class, Object...), newInnerInstance(Class, Object, Object...), newInstance(String, Class[], Object...)

newInstance

public static <T> T newInstance(Class<? extends T> classToInstantiate,
                                Object... nonNullArgs)

Creates a new instance of a given class, invoking the constructor which has parameters matching the number, order, and types of the given non-null arguments.

Type Parameters:

T - type to which the returned instance should be assignable

Parameters:

nonNullArgs - zero or more non-null parameter values for the invocation; if a null value needs to be passed, the Class object for the corresponding parameter type must be passed instead

Returns:

a newly created instance of the specified class, initialized with the given arguments

Throws:

IllegalArgumentException - if a null reference was provided for a parameter, or if no constructor was found that matched the given argument types

See Also:

newInnerInstance(Class, Object, Object...), newInstance(String, Object...), newInstance(String, Class[], Object...)

newInstance

public static <T> T newInstance(String className,
                                Class<?>[] parameterTypes,
                                Object... initArgs)

Creates a new instance of a given non-accessible class, invoking the constructor which has the specified parameter types.

Type Parameters:

T - type to which the returned instance should be assignable

Parameters:

className - the fully qualified name of the desired class

parameterTypes - the formal parameter types for the desired constructor, possibly empty

initArgs - the invocation arguments for the constructor, which must be consistent with the specified parameter types

Returns:

a newly created instance of the specified class, initialized through the specified constructor and arguments

See Also:

newInstance(String, Object...), newInstance(Class, Class[], Object...), newInnerInstance(String, Object, Object...)

newInstance

public static <T> T newInstance(String className,
                                Object... nonNullArgs)

Creates a new instance of a given non-accessible class, invoking the constructor which has parameters matching the number, order, and types of the given non-null arguments.

Type Parameters:

T - type to which the returned instance should be assignable

Parameters:

nonNullArgs - zero or more non-null parameter values for the invocation; if a null value needs to be passed, the Class object for the corresponding parameter type must be passed instead

Returns:

a newly created instance of the specified class, initialized with the given arguments

Throws:

IllegalArgumentException - if a null reference was provided for a parameter, or if no constructor was found that matched the given argument types

See Also:

newInnerInstance(String, Object, Object...), newInstance(Class, Object...), newInstance(String, Class[], Object...)

newUninitializedInstance

public static <T> T newUninitializedInstance(Class<? extends T> classToInstantiate)

Creates a new instance of a given class, without invoking any constructor. If the given class is abstract or an interface, then a concrete class is created, with empty implementations for the abstract/interface methods.

Type Parameters:

T - type to which the returned instance should be assignable

Parameters:

classToInstantiate - the class to be instantiated

Returns:

a newly created instance of the specified class, with any instance fields left uninitialized

See Also:

newInstance(Class, Object...), newInstance(String, Class[], Object...), newInnerInstance(Class, Object, Object...)

setField

public static void setField(Class<?> classWithStaticField,
                            Object fieldValue)

Sets the value of a non-accessible static field on a given class. The field is looked up by the type of the given field value instead of by name.

Parameters:

classWithStaticField - the class on which the static field is defined

fieldValue - the value to set the field to

Throws:

IllegalArgumentException - if either the desired field is not found, or more than one is

See Also:

setField(Class, String, Object), setField(Object, Object), getField(Class, Class)

setField

public static void setField(Class<?> classWithStaticField,
                            String fieldName,
                            Object fieldValue)

Sets the value of a non-accessible static field on a given class.

Parameters:

classWithStaticField - the class on which the static field is defined

fieldName - the name of the field to set

fieldValue - the value to set the field to

Throws:

IllegalArgumentException - if the desired field is not found

See Also:

setField(Class, Object), setField(Object, String, Object), getField(Class, String)

setField

public static void setField(Object objectWithField,
                            Object fieldValue)

Sets the value of a non-accessible field on a given object. The field is looked up by the type of the given field value instead of by name.

Throws:

IllegalArgumentException - if either the desired field is not found, or more than one is

See Also:

setField(Object, String, Object), setField(Class, String, Object), getField(Object, String)

setField

public static void setField(Object objectWithField,
                            String fieldName,
                            Object fieldValue)

Sets the value of a non-accessible field on a given object.

Parameters:

objectWithField - the instance on which to set the field value

fieldName - the name of the field to set

fieldValue - the value to set the field to

Throws:

IllegalArgumentException - if the desired field is not found

See Also:

setField(Class, String, Object), setField(Object, Object), getField(Object, String)