org.netbeans.modules.maven.api.execute

Interface RunConfig

All Known Implementing Classes:

BeanRunConfig, ModelRunConfig

public interface RunConfig

Context provider for maven executors and checkers. Never to be implemented by client code.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RunConfig.ReactorStyle

Method Summary

Modifier and Type	Method and Description
void	addProperties(Map<String,String> properties)
default Lookup	getActionContext() Provides access to possible additional parameters from the action invoker.
String	getActionName()
List<String>	getActivatedProfiles()
File	getExecutionDirectory() directory where the maven build execution happens.
String	getExecutionName()
List<String>	getGoals() goals to be executed.
Map<? extends String,? extends Object>	getInternalProperties()
org.apache.maven.project.MavenProject	getMavenProject() the maven project instance loaded with the context of execution, with execution's profiles enabled and execution properties injected.
RunConfig	getPreExecution()
Project	getProject() project that is being used for execution, can be null.
Map<? extends String,? extends String>	getProperties() Properties to be used in execution.
RunConfig.ReactorStyle	getReactorStyle()
FileObject	getSelectedFileObject()
String	getTaskDisplayName()
boolean	isInteractive()
Boolean	isOffline()
boolean	isRecursive()
boolean	isShowDebug()
boolean	isShowError()
boolean	isUpdateSnapshots()
void	setActivatedProfiles(List<String> profiles)
void	setExecutionDirectory(File directory)
void	setInternalProperty(String key, Object value)
void	setOffline(Boolean bool)
void	setPreExecution(RunConfig config)
void	setProperty(String key, String value)

Method Detail

getExecutionDirectory

File getExecutionDirectory()

directory where the maven build execution happens.

Returns:

setExecutionDirectory

void setExecutionDirectory(File directory)

getPreExecution

RunConfig getPreExecution()

setPreExecution

void setPreExecution(RunConfig config)

getReactorStyle

RunConfig.ReactorStyle getReactorStyle()

getProject

Project getProject()

project that is being used for execution, can be null.

Returns:

getMavenProject

org.apache.maven.project.MavenProject getMavenProject()

the maven project instance loaded with the context of execution, with execution's profiles enabled and execution properties injected. Can differd from the MavenProject returned from within the Project instance. All Maven model checks shall be done against this instance.

Returns:

getGoals

List<String> getGoals()

goals to be executed.

Returns:

a list of goals to run

getExecutionName

String getExecutionName()

getTaskDisplayName

String getTaskDisplayName()

getActionName

String getActionName()

getProperties

@NonNull
Map<? extends String,? extends String> getProperties()

Properties to be used in execution.

Returns:

a read-only copy of the current properties (possibly inherited from the parent)

setProperty

void setProperty(@NonNull
                 String key,
                 @NullAllowed
                 String value)

addProperties

void addProperties(@NonNull
                   Map<String,String> properties)

setInternalProperty

void setInternalProperty(@NonNull
                         String key,
                         @NullAllowed
                         Object value)

getInternalProperties

@NonNull
Map<? extends String,? extends Object> getInternalProperties()

isShowDebug

boolean isShowDebug()

isShowError

boolean isShowError()

isOffline

Boolean isOffline()

setOffline

void setOffline(Boolean bool)

isRecursive

boolean isRecursive()

isUpdateSnapshots

boolean isUpdateSnapshots()

getActivatedProfiles

List<String> getActivatedProfiles()

setActivatedProfiles

void setActivatedProfiles(List<String> profiles)

isInteractive

boolean isInteractive()

getSelectedFileObject

FileObject getSelectedFileObject()

getActionContext

default Lookup getActionContext()

Provides access to possible additional parameters from the action invoker. Must not return null, use Lookup.EMPTY for empty instance.

Returns:

action context Lookup

Since:

2.144