uk.ac.sheffield.vtts.ground

Class JavaDependency

java.lang.Object

uk.ac.sheffield.vtts.ground.JavaDependency

public class JavaDependency
extends java.lang.Object

JavaDependency analyses the dependency of test code on external packages. JavaDependency has the task of helping a Java-based grounding to resolve its dependencies on external Java packages. It maintains the relationship between the target package (for the generated Test Driver) and any source packages (for external user-defined classes), so that the correct import statements are included in the generated code; and also ensures that, if a JavaFactory is required to synthesise instances of external types, it is notified about the external user packages in which to search.

Version:

Broker@Cloud 1.0

Author:

Anthony J H Simons

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	factoryLocation The assumed package location of the JavaFactory factory, which is used to create instances of complex (generic) types, or user-defined types.

Constructor Summary

Constructors

Constructor and Description
JavaDependency() Constructs this JavaDependency visitor.

Method Summary

Methods

Modifier and Type	Method and Description
void	analyse(TestSuite testSuite) Analyses the TestSuite looking for complex types in the inputs and outputs of each tested Operation.
protected void	analyseInput(Input input) Analyses one Input parameter to determine whether it is of a complex generic, or factory-created type.
protected void	analyseOutput(Output output) Analyses one Output parameter to determine whether it is of a complex generic, or factory-created type.
java.util.List<java.lang.String>	getImports() Returns all the needed package locations as a List of Strings.
java.util.Set<java.lang.String>	getSourcePackages() Returns the user-defined source package names as a set of Strings.
java.lang.String	getTargetPackage() Returns the name of the user-defined target package.
boolean	hasFactory() Reports whether this JavaDependency detected the need for a Factory.
boolean	hasFactoryInputs() Reports whether this JavaDependency has detected a need to build factory inputs.
boolean	hasFactoryOutputs() Reports whether this JavaDependency has detected a need to build factory outputs.
boolean	hasGenericInputs() Reports whether this JavaDependency has detected a need to encode generic inputs.
boolean	hasGenericOutputs() Reports whether this JavaDependency has detected a need to decode generic outputs.
protected boolean	isGeneric(java.lang.String type) Tests whether the supplied model type is a generic type.
void	useSourcePackage(java.lang.String packageInfo) Adds a package path name to the set of package names for source files.
void	useTargetPackage(java.lang.String packageInfo) Sets the path name of the package for the generated target file.

Methods inherited from class java.lang.Object

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

Field Detail

factoryLocation

public static java.lang.String factoryLocation

The assumed package location of the JavaFactory factory, which is used to create instances of complex (generic) types, or user-defined types.

Constructor Detail

JavaDependency

public JavaDependency()

Constructs this JavaDependency visitor. Initialises the package map for Java class dependencies, and the list of user packages.

Method Detail

analyse

public void analyse(TestSuite testSuite)

Analyses the TestSuite looking for complex types in the inputs and outputs of each tested Operation. Complex types include generic types and user-defined class types. These may require specific package import statements, or a JavaFactory to synthesise values, or both. Iterates over every TestStep in every TestSequence in the TestSuite and analyses the type of every Input and Output of each Operation.

Parameters:

testSuite - the TestSuite to be analysed.

analyseInput

protected void analyseInput(Input input)

Analyses one Input parameter to determine whether it is of a complex generic, or factory-created type.

Parameters:

input - the Input parameter.

analyseOutput

protected void analyseOutput(Output output)

Analyses one Output parameter to determine whether it is of a complex generic, or factory-created type.

Parameters:

output - the Output parameter.

isGeneric

protected boolean isGeneric(java.lang.String type)

Tests whether the supplied model type is a generic type.

Parameters:

type - the model type, possibly containing [] generic brackets.

Returns:

true, if the model type contains [] generic brackets.

useSourcePackage

public void useSourcePackage(java.lang.String packageInfo)

Adds a package path name to the set of package names for source files. Both of the null package name and the empty String are treated as the default package name.

Parameters:

packageInfo - the package location as a String.

useTargetPackage

public void useTargetPackage(java.lang.String packageInfo)

Sets the path name of the package for the generated target file. Both of the null package name and the empty String are treated as the default package name.

Parameters:

packageInfo - the package location as a String.

getSourcePackages

public java.util.Set<java.lang.String> getSourcePackages()

Returns the user-defined source package names as a set of Strings.

Returns:

a set of user-defined source packages.

getTargetPackage

public java.lang.String getTargetPackage()

Returns the name of the user-defined target package. If not set, this is the empty String representing the default package.

Returns:

the name of the target package.

hasFactory

public boolean hasFactory()

Reports whether this JavaDependency detected the need for a Factory. If the tests contained inputs or outputs of complex types, that is, any type other than the simple types, a JavaFactory will be needed. Tests whether the "Factory" key was added to the Java imports, after analysing the TestSuite.

Returns:

true, if a JavaFactory is needed.

hasGenericInputs

public boolean hasGenericInputs()

Reports whether this JavaDependency has detected a need to encode generic inputs. A suitable encoder into JSON may be required.

Returns:

true if tests accept generic inputs.

hasGenericOutputs

public boolean hasGenericOutputs()

Reports whether this JavaDependency has detected a need to decode generic outputs. A suitable decoder from JSON may be required.

Returns:

true if tests return generic outputs.

hasFactoryInputs

public boolean hasFactoryInputs()

Reports whether this JavaDependency has detected a need to build factory inputs. This will use the JavaFactory.

Returns:

true, if tests accept factory-generated inputs.

hasFactoryOutputs

public boolean hasFactoryOutputs()

Reports whether this JavaDependency has detected a need to build factory outputs. This will use the JavaFactory.

Returns:

true, if tests return factory-generated outputs.

getImports

public java.util.List<java.lang.String> getImports()

Returns all the needed package locations as a List of Strings. This is a list of individual Java class imports and whole user-package imports. The early imports in this list are utility Java classes; and the later imports are user-declared source packages (minus the target package).

Returns:

a list of Java and user package locations.