soot.plugins

Interface SootPhasePlugin

public interface SootPhasePlugin

An interface every phase plugin has to implement. The plugin has to support basic functionality, such as creating the transformer and support a list of possible options. The first method that is called after object creation is setDescription then the list of possible parameters is called and the last step is the call to getTransformer.

Author:

Bernhard J. Berger

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENABLED_BY_DEFAULT Default option for enabling a plugin.

Method Summary

Modifier and Type	Method and Description
String[]	getDeclaredOptions()
String[]	getDefaultOptions() Returns a list of default values for initializing the parameters.
Transformer	getTransformer() Creates a new transformer instance (either SceneTransformer or BodyTransformer).
void	setDescription(PhasePluginDescription pluginDescription)

Field Detail

ENABLED_BY_DEFAULT

static final String ENABLED_BY_DEFAULT

Default option for enabling a plugin.

See Also:

Constant Field Values

Method Detail

getDeclaredOptions

String[] getDeclaredOptions()

Returns:

a list of phase options.

getDefaultOptions

String[] getDefaultOptions()

Returns a list of default values for initializing the parameters. Each entry in the list is of kind ":". Please note, that you have to add the ENABLED_BY_DEFAULT option if you want the plugin to be enabled.

Returns:

a list of default values.

getTransformer

Transformer getTransformer()

Creates a new transformer instance (either SceneTransformer or BodyTransformer). The method will be called just once.

Returns:

a new transformer instance.

setDescription

void setDescription(PhasePluginDescription pluginDescription)