org.netbeans.modules.maven.api.execute

Class RunUtils

java.lang.Object

org.netbeans.modules.maven.api.execute.RunUtils

public final class RunUtils
extends Object

Utility method for executing a maven build, using the RunConfig.

Method Summary

Modifier and Type	Method and Description
static RunConfig	cloneRunConfig(RunConfig original) return a new instance of runconfig by the template passed as parameter
static RunConfig	createRunConfig(File execDir, Project prj, String displayName, List<String> goals)
static RunConfig	createRunConfig(String action, Project prj, ProjectConfiguration c, Lookup lookup) Creates a RunConfig for the specified project action.
static ExecutorTask	executeMaven(RunConfig config) Execute maven build in NetBeans execution engine.
static boolean	hasApplicationCompileOnSaveEnabled(Project prj) Deprecated.
static boolean	hasApplicationCompileOnSaveEnabled(RunConfig config) Deprecated.
static boolean	hasTestCompileOnSaveEnabled(Project prj) Deprecated.
static boolean	hasTestCompileOnSaveEnabled(RunConfig config) Deprecated.
static boolean	isCompileOnSaveEnabled(Project prj)
static boolean	isCompileOnSaveEnabled(RunConfig config)
static ExecutorTask	run(RunConfig config) Runs Maven after checking prerequisites.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

run

@CheckForNull
public static ExecutorTask run(RunConfig config)

Runs Maven after checking prerequisites.

Parameters:

config - a run configuration (try RunUtils.createRunConfig(java.lang.String, org.netbeans.api.project.Project, org.netbeans.spi.project.ProjectConfiguration, org.openide.util.Lookup))

Returns:

a task to track progress, or null if prerequisites were not satisfied

Since:

2.18

See Also:

RunUtils.executeMaven(org.netbeans.modules.maven.api.execute.RunConfig), PrerequisitesChecker

executeMaven

public static ExecutorTask executeMaven(RunConfig config)

Execute maven build in NetBeans execution engine. Most callers should rather use RunUtils.run(org.netbeans.modules.maven.api.execute.RunConfig) as this variant does no (non-late-bound) prerequisite checks. It is mostly suitable for cases where you need full control by the caller over the config, or want to rerun a previous execution.

Parameters:

config -

Returns:

createRunConfig

public static RunConfig createRunConfig(String action,
                                        Project prj,
                                        ProjectConfiguration c,
                                        Lookup lookup)

Creates a RunConfig for the specified project action. Project configuration to be used can be also specified, which affects potentially the action's mapping and/or properties. If null is passed, the current/active configuration is used. If applied on non-Maven project, the method returns null, as well as if the requested action does not exist in the project or its requested (or active) configuration.

Parameters:

action - project action name

prj - the project

c - the configuration to use, use null for the active one.

lookup - lookup that becomes available to the action provider for possible further data / options

Returns:

configured RunConfig suitable for execution or null if the project is not maven, or action is unavailable.

Since:

2.157

createRunConfig

public static RunConfig createRunConfig(File execDir,
                                        Project prj,
                                        String displayName,
                                        List<String> goals)

cloneRunConfig

public static RunConfig cloneRunConfig(RunConfig original)

return a new instance of runconfig by the template passed as parameter

Parameters:

original -

Returns:

Since:

2.40

isCompileOnSaveEnabled

public static boolean isCompileOnSaveEnabled(Project prj)

isCompileOnSaveEnabled

public static boolean isCompileOnSaveEnabled(RunConfig config)

hasApplicationCompileOnSaveEnabled

@Deprecated
public static boolean hasApplicationCompileOnSaveEnabled(Project prj)

Deprecated.

Parameters:

prj -

Returns:

true if compile on save is allowed for running the application.

hasApplicationCompileOnSaveEnabled

@Deprecated
public static boolean hasApplicationCompileOnSaveEnabled(RunConfig config)

Deprecated.

Parameters:

config -

Returns:

true if compile on save is allowed for running the application.

hasTestCompileOnSaveEnabled

@Deprecated
public static boolean hasTestCompileOnSaveEnabled(Project prj)

Deprecated.

Parameters:

prj -

Returns:

true if compile on save is allowed for running tests.

hasTestCompileOnSaveEnabled

@Deprecated
public static boolean hasTestCompileOnSaveEnabled(RunConfig config)

Deprecated.

Parameters:

config -

Returns:

true if compile on save is allowed for running tests.