com.tplan.robot.plugin

Interface JavaLibrary

public interface JavaLibrary

Interface allowing plugins to declare that they provide a Java API for use in Java test scripts and that their containing JAR file or class path should be put on the on-the-fly Java compiler class path.

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PLUGIN_LIBRARY_PATH_KEY This key is used to store class path to plugin Java libraries in the system property table (System.getProperty()).

Method Summary

Modifier and Type	Method and Description
boolean	isLibrary() Plugins which are Java libraries should return true.

Field Detail

PLUGIN_LIBRARY_PATH_KEY

static final String PLUGIN_LIBRARY_PATH_KEY

This key is used to store class path to plugin Java libraries in the system property table (System.getProperty()). The Plugin Manager will populate this path with list of all plugin packages which are Java libraries (meaning they implement this interface and their isLibrary() method returns true). The Java compiler retrieves the path and adds it to the class path whenever a Java test script is being compiled.

See Also:

Constant Field Values

Method Detail

isLibrary

boolean isLibrary()

Plugins which are Java libraries should return true. This method allows to specify dynamically whether the plugin is a library or not. It makes sense where the plugin delivers both new functionality as well as the API and the user may select (for example in Preferences) whether the API is used or not. As adding the plugin package to the class path delays the compiler, it makes sense to switch it of if not used to improve performance.

Returns:

true if the plugin package serves also as a Java library, false if not.