org.jboss.windup.tooling

Interface ExecutionBuilder

All Superinterfaces:

Remote

public interface ExecutionBuilder
extends Remote

The initial call, specifying the installation path to Windup.

Author:

Jesse Sightler

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOOKUP_NAME

Method Summary

Modifier and Type	Method and Description
void	addUserRulesPath(String rulesPath) Adds a custom uer rules path.
void	addUserRulesPaths(Iterable<String> rulesPath) Adds a set of custom uer rules paths.
void	clear() Clears the configuration information.
void	excludePackage(String excludePackagePrefix) Sets the package name prefixes to ignore.
void	excludePackages(Collection<String> excludePackagePrefixes) Sets a list of package name prefixes to ignore.
ExecutionResults	execute() Execute windup.
String	getEnv(String name) Returns the system environment variable value.
RuleProviderRegistry	getRuleProviderRegistry(List<String> paths) Returns the registry containing the rule providers.
RuleProviderRegistry	getSystemRuleProviderRegistry() Returns the registry containing the system rule providers.
String	getVersion() Returns the Windup version.
void	ignore(String ignorePattern) Sets a pattern of file paths to ignore during processing.
void	includePackage(String includePackagePrefix) Sets the package name prefixes to scan (the default is to scan all packages).
void	includePackages(Collection<String> includePackagePrefixes) Includes the provided list of package prefixes.
void	setInput(Set<String> input) Sets the input path(s) (list of application source directories, or application binary files).
void	setOption(String name, Object value) Sets the option with the specified name to the specified value.
void	setOutput(String output) Sets the output path for Windup (where the graph will be stored, and where the reports will be generated).
void	setProgressMonitor(WindupToolingProgressMonitor monitor) Sets the callback that will be used for monitoring progress.
void	setVersion(String version) Sets the version of Windup.
void	setWindupHome(String windupHome) Start building a Windup execution with a windup that is installed at the specified path.
void	skipReportGeneration() Indicates that Windup should not generate reports at the end.
void	sourceOnlyMode() Switches the engine to run in source only mode (no decompilation).
void	terminate() Terminates the runtime that registered this ExecutionBuilder.
String	transform(String transformationID, QuickfixLocationDTO locationDTO) Executes the quickfix transformation.

Field Detail

LOOKUP_NAME

static final String LOOKUP_NAME

See Also:

Constant Field Values

Method Detail

setWindupHome

void setWindupHome(String windupHome)
            throws RemoteException

Start building a Windup execution with a windup that is installed at the specified path.

Throws:

RemoteException

setProgressMonitor

void setProgressMonitor(WindupToolingProgressMonitor monitor)
                 throws RemoteException

Sets the callback that will be used for monitoring progress.

Throws:

RemoteException

setInput

void setInput(Set<String> input)
       throws RemoteException

Sets the input path(s) (list of application source directories, or application binary files).

Throws:

RemoteException

ignore

void ignore(String ignorePattern)
     throws RemoteException

Sets a pattern of file paths to ignore during processing.

Throws:

RemoteException

includePackage

void includePackage(String includePackagePrefix)
             throws RemoteException

Sets the package name prefixes to scan (the default is to scan all packages).

Throws:

RemoteException

excludePackage

void excludePackage(String excludePackagePrefix)
             throws RemoteException

Sets the package name prefixes to ignore.

Throws:

RemoteException

setOption

void setOption(String name,
               Object value)
        throws RemoteException

Sets the option with the specified name to the specified value. Option names can be found in static variables on ConfigurationOption implementations.

Throws:

RemoteException

execute

ExecutionResults execute()
                  throws RemoteException

Execute windup.

Throws:

RemoteException

setOutput

void setOutput(String output)
        throws RemoteException

Sets the output path for Windup (where the graph will be stored, and where the reports will be generated).

Throws:

RemoteException

includePackages

void includePackages(Collection<String> includePackagePrefixes)
              throws RemoteException

Includes the provided list of package prefixes.

Throws:

RemoteException

excludePackages

void excludePackages(Collection<String> excludePackagePrefixes)
              throws RemoteException

Sets a list of package name prefixes to ignore.

Throws:

RemoteException

sourceOnlyMode

void sourceOnlyMode()
             throws RemoteException

Switches the engine to run in source only mode (no decompilation).

Throws:

RemoteException

skipReportGeneration

void skipReportGeneration()
                   throws RemoteException

Indicates that Windup should not generate reports at the end.

Throws:

RemoteException

addUserRulesPath

void addUserRulesPath(String rulesPath)
               throws RemoteException

Adds a custom uer rules path.

Throws:

RemoteException

addUserRulesPaths

void addUserRulesPaths(Iterable<String> rulesPath)
                throws RemoteException

Adds a set of custom uer rules paths.

Throws:

RemoteException

clear

void clear()
    throws RemoteException

Clears the configuration information.

Throws:

RemoteException

terminate

void terminate()
        throws RemoteException

Terminates the runtime that registered this ExecutionBuilder.

Throws:

RemoteException

getVersion

String getVersion()
           throws RemoteException

Returns the Windup version.

Throws:

RemoteException

setVersion

void setVersion(String version)
         throws RemoteException

Sets the version of Windup.

Throws:

RemoteException

getRuleProviderRegistry

RuleProviderRegistry getRuleProviderRegistry(List<String> paths)
                                      throws RemoteException

Returns the registry containing the rule providers.

Throws:

RemoteException

getSystemRuleProviderRegistry

RuleProviderRegistry getSystemRuleProviderRegistry()
                                            throws RemoteException

Returns the registry containing the system rule providers.

Throws:

RemoteException

transform

String transform(String transformationID,
                 QuickfixLocationDTO locationDTO)
          throws RemoteException

Executes the quickfix transformation.

Throws:

RemoteException

getEnv

String getEnv(String name)
       throws RemoteException

Returns the system environment variable value.

Throws:

RemoteException