Package org.apache.maven.cling.executor

Interface ExecutorHelper

All Superinterfaces:

ExecutorTool

All Known Implementing Classes:

HelperImpl

public interface ExecutorHelper
extends ExecutorTool

Helper class for routing Maven execution based on preferences and/or issued execution requests.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ExecutorHelper.Mode	The modes of execution.

Method Summary

Modifier and Type	Method	Description
default int	execute(ExecutorRequest executorRequest)	Executes the request with preferred mode executor.
int	execute(ExecutorHelper.Mode mode, ExecutorRequest executorRequest)	Executes the request with passed in mode executor.
ExecutorRequest.Builder	executorRequest()	Creates pre-populated builder for ExecutorRequest.
ExecutorHelper.Mode	getDefaultMode()	Returns the preferred mode of this helper.
String	mavenVersion()	High level operation, returns the version of the Maven covered by this helper.

Methods inherited from interface org.apache.maven.cling.executor.ExecutorTool

artifactPath, dump, localRepository, metadataPath

Method Details

getDefaultMode

@Nonnull
ExecutorHelper.Mode getDefaultMode()

Returns the preferred mode of this helper.

executorRequest

@Nonnull
ExecutorRequest.Builder executorRequest()

Creates pre-populated builder for ExecutorRequest. Users of helper must use this method to create properly initialized request builder.

execute

default int execute(ExecutorRequest executorRequest)
             throws ExecutorException

Executes the request with preferred mode executor.

Throws:

ExecutorException

execute

int execute(ExecutorHelper.Mode mode,
 ExecutorRequest executorRequest)
     throws ExecutorException

Executes the request with passed in mode executor.

Throws:

ExecutorException

mavenVersion

@Nonnull
String mavenVersion()

High level operation, returns the version of the Maven covered by this helper. This method call caches underlying operation, and is safe to invoke as many times needed.

See Also:

• Executor.mavenVersion(ExecutorRequest)