org.safs.model.annotations

Class Utilities

java.lang.Object

org.safs.model.annotations.Utilities

public class Utilities
extends java.lang.Object

Utilities for use by mostly internal classes implementing autoconfigure and execution modes of JSAFS.

Since:

OCT 15, 2013

Author:

Carl Nagle

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static java.lang.String	FILE_COLON_STRING

Constructor Summary

Constructors

Constructor and Description
Utilities()

Method Summary

Modifier and Type	Method and Description
static void	autoConfigure(java.lang.String className, JSAFSConfiguredClassStore store) This is where auto-configuration and execution of JSAFS-specific tests will generally occur.
(package private) static void	debug(java.lang.String message)
(package private) static void	executeAnnotatedMethods(java.util.Hashtable<java.lang.Integer,java.util.Hashtable<java.lang.reflect.Method,java.lang.Object>> annotatedMehods, boolean ascending) Execute methods stored in a hashtable according to the method's order.
static java.util.List<java.lang.Class<?>>	getPackageClasses(java.lang.String classname, java.util.List<java.lang.Class<?>> cList, java.util.List<java.lang.String> exclusions) Given a full classname (not a package name) find the parent package and attempt to locate all classes in that package and all sub-packages.
static void	injectRuntimeDataAwareClasses(java.lang.Object classInstance, java.util.ArrayList<java.lang.String> altPackageNames, RuntimeDataInterface dataInterface) Look for classes (like AppMapGenerated classes) that may want access to a RuntimeDataInterface.

Methods inherited from class java.lang.Object

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

Field Detail

FILE_COLON_STRING

static final java.lang.String FILE_COLON_STRING

See Also:

Constant Field Values

Constructor Detail

Utilities

public Utilities()

Method Detail

debug

static void debug(java.lang.String message)

getPackageClasses

public static java.util.List<java.lang.Class<?>> getPackageClasses(java.lang.String classname,
                                                                   java.util.List<java.lang.Class<?>> cList,
                                                                   java.util.List<java.lang.String> exclusions)

Given a full classname (not a package name) find the parent package and attempt to locate all classes in that package and all sub-packages.

The routine will be creating a static copy of each Class, so the classes will go through their initial static initialization if this has not already happened.

Parameters:

classname - -- the full name of the class to interrogate. Ex: my.test.package.MyTest

cList - -- the current List of classes to append to.

exclusions - -- a List of package names (not classnames) to be excluded from the search. Ex: my.test.package.otherstuff

Returns:

The input cList with all newly found Classes appended to it. This allows for the collection of many classes across different package hierarchies.

See Also:

#getPackageClasses(Package, List, List)

injectRuntimeDataAwareClasses

public static void injectRuntimeDataAwareClasses(java.lang.Object classInstance,
                                                 java.util.ArrayList<java.lang.String> altPackageNames,
                                                 RuntimeDataInterface dataInterface)

Look for classes (like AppMapGenerated classes) that may want access to a RuntimeDataInterface. Look in the package of the provided classInstance. Look in other packages using the altPackageNames array provided by the caller. We will attempt to use these altPackageNames as both subpackages of the parent package and standalone fullpath package names.

EXPERIMENTAL

It is IMPORTANT to note that this Dependency Injection model will create a temporary and non-cached instance of the RuntimeDataAware Class solely for the purpose of invoking the setRuntimeDataInterface instance Method. In order for subsequent instances to make use of the RuntimeDataInterface object it is necessary that any and all instances should store it in a shared (static) field.

This is NOT part of the normal autoConfigure(String, JSAFSConfiguredClassStore) process. That process is separate and independent and may happen in addition to this function.

Parameters:

classInstance - -- The class instance--usually the Main class for the test--to use to seek associated packages and classes containing RuntimeDataAware classes.

altPackageNames - -- list of associated package names to search for RuntimeDataAware classes.

dataInterface - -- the RuntimeDataInterface to pass along to RuntimeDataAware classes.

See Also:

AppMapGenerator, RuntimeDataAware, RuntimeDataInterface, RuntimeDataAware.setRuntimeDataInterface(RuntimeDataInterface)

autoConfigure

public static void autoConfigure(java.lang.String className,
                                 JSAFSConfiguredClassStore store)

This is where auto-configuration and execution of JSAFS-specific tests will generally occur. The routine is generally called internally by other JSAFS classes and methods.

The Class initialized from the className is checked for the AutoConfigureJSAFS annotation to see if additional class packages and sub-packages should be included or excluded from the configuration and execution.

The routine will identify and instantiate all the classes in the package and all sub-packages relative the inclusion list. Those Classes and Methods within the Classes containing JSAFS annotations for configuration or execution will be configured and prepared for execution--including the proper sorting of execution order, if any.

All successfully instantiated Object instances are stored for post-test availability.

After all preparations are complete, any Methods tagged for execution are executed in the order as defined by associated annotations.

Parameters:

className - -- Initially, the name of the class that is requesting the automatic configuration and execution. For example, the Runner Class will call into here with the name of the class that invoked Runner.autorun().

store - -- the JSAFSConfiguredClassStore that will maintain references to instantiated object instances for later use by the user, if needed.

See Also:

Runner.autorun(String[]), Runner.getConfiguredClassInstance(String)

executeAnnotatedMethods

static void executeAnnotatedMethods(java.util.Hashtable<java.lang.Integer,java.util.Hashtable<java.lang.reflect.Method,java.lang.Object>> annotatedMehods,
                                    boolean ascending)

Execute methods stored in a hashtable according to the method's order.

Parameters:

annotatedMehods - Hashtable> contains methods, key is the method's order

ascending, - boolean, True to execute methods in ascending order; False in descending order.