com.meterware.simplestub

Class StaticStubSupport

java.lang.Object

com.meterware.simplestub.StaticStubSupport

public abstract class StaticStubSupport
extends Object

A class which simplifies the assignment of stubs to static variables.

Author:

Russell Gold

Method Summary

Modifier and Type	Method and Description
static Memento	install(Class<?> containingClass, String fieldName, Object newValue) This method assigns the specified value to the named field in the specified class.
static Class<?>	nestedClass(Class<?> aClass, String... nestedClassNames) Returns the nested class specified by an outer class and a sequences of class names.
static Memento	preserve(Class<?> containingClass, String fieldName) This method returns a Memento object which can be used to revert the specified field to its current value.

Methods inherited from class java.lang.Object

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

Method Detail

install

public static Memento install(Class<?> containingClass,
                              String fieldName,
                              Object newValue)
                       throws NoSuchFieldException

This method assigns the specified value to the named field in the specified class. It returns a Memento object which can be used to revert that field to its original value.

Parameters:

containingClass - the class on which the static field is defined.

fieldName - the name of the static field.

newValue - the value to place into the static field.

Returns:

an object which holds the information needed to revert the static field.

Throws:

NoSuchFieldException - if the named field does not exist.

preserve

public static Memento preserve(Class<?> containingClass,
                               String fieldName)
                        throws NoSuchFieldException

This method returns a Memento object which can be used to revert the specified field to its current value.

Parameters:

containingClass - the class on which the static field is defined.

fieldName - the name of the static field.

Returns:

an object which holds the information needed to revert the static field.

Throws:

NoSuchFieldException - if the named field does not exist.

nestedClass

public static Class<?> nestedClass(Class<?> aClass,
                                   String... nestedClassNames)
                            throws ClassNotFoundException

Returns the nested class specified by an outer class and a sequences of class names. If more than one class name is specified, they will be appended to one another. For example, the nested class Foo$Bar$Baz can be retrieved by nestedClass(Foo.class, "Bar", "Baz").

Parameters:

aClass - the outer class containing the desired nested class

nestedClassNames - one or more nested class names

Returns:

the desired inner class

Throws:

ClassNotFoundException - if no such nested class exists.