org.netbeans.modules.gradle.api.execute

Class GradleCommandLine

java.lang.Object

org.netbeans.modules.gradle.api.execute.GradleCommandLine

All Implemented Interfaces:

Serializable

public final class GradleCommandLine
extends Object
implements Serializable

Object representation of a Gradle command line. This object can be used to add remove different flags, options and properties in a Gradle command line. It can be used to merge and subtract command lines.

Since:

1.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GradleCommandLine.Flag Gradle command line flags
static interface	GradleCommandLine.GradleOptionItem
static class	GradleCommandLine.LogLevel Gradle log levels.
static class	GradleCommandLine.Parameter
static class	GradleCommandLine.Property
static class	GradleCommandLine.StackTrace Gradle stacktrace output levels.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHECK_TASK The common name of the task which invokes checks.
static String	TEST_TASK The common name of the task which invokes tests.

Constructor Summary

Constructors

Constructor and Description
GradleCommandLine(CharSequence argLine)
GradleCommandLine(GradleCommandLine cmd) Creates a copy instance of the provided GradleCommandLine.
GradleCommandLine(GradleDistributionManager.GradleDistribution dist, CharSequence argLine)
GradleCommandLine(GradleDistributionManager.GradleDistribution dist, GradleCommandLine cmd) /** Creates a copy instance of the provided GradleCommandLine, but with for a specified GradleDistribution.
GradleCommandLine(GradleDistributionManager.GradleDistribution dist, String... args) Creates a command line form the specified arguments with compatibility constraint on a specified Gradle distribution.
GradleCommandLine(String... args)

Method Summary

Modifier and Type	Method and Description
void	addFlag(GradleCommandLine.Flag flag)
void	addParameter(GradleCommandLine.Parameter param, String value)
void	addProjectProperty(String key, String value)
void	addSystemProperty(String key, String value)
void	addTask(String task)
boolean	canAdd(GradleCommandLine.Flag flag)
boolean	canAdd(GradleCommandLine.GradleOptionItem item)
static GradleCommandLine	combine(GradleCommandLine first, GradleCommandLine... layers)
void	configure(org.gradle.tooling.ConfigurableLauncher<?> launcher) Configures the given Gradle Launcher considering the options set in this command line.
void	configure(org.gradle.tooling.ConfigurableLauncher<?> launcher, File rootDir) Configures the given Gradle Launcher considering the options set in this command line and the Java VM arguments specified by the given project dir.
static GradleCommandLine	getDefaultCommandLine()
Set<String>	getExcludedTasks()
String	getFirstParameter(GradleCommandLine.Parameter param)
List<String>	getFullCommandLine() Retrieve the command line as a list of strings.
GradleCommandLine.LogLevel	getLoglevel()
Collection<String>	getParameters(GradleCommandLine.Parameter param)
String	getProperty(GradleCommandLine.Property type, String key)
GradleCommandLine.StackTrace	getStackTrace()
List<String>	getSupportedCommandLine() Retrieve the command line which is actually supported to be executed from the IDE.
Set<String>	getTasks()
boolean	hasFlag(GradleCommandLine.Flag flag)
boolean	hasParameter(GradleCommandLine.Parameter param)
boolean	hasTask(String task)
GradleCommandLine	remove(GradleCommandLine mask)
void	removeFlag(GradleCommandLine.Flag flag)
void	removeParameter(GradleCommandLine.Parameter param, String value)
void	removeParameters(GradleCommandLine.Parameter param)
void	removeProperty(GradleCommandLine.Property prop, String key)
void	removeTask(String task)
void	setExcludedTasks(Collection<String> excluded)
void	setFlag(GradleCommandLine.Flag flag, boolean b)
void	setLogLevel(GradleCommandLine.LogLevel level)
void	setStackTrace(GradleCommandLine.StackTrace st)
void	setTasks(Collection<String> tasks)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

TEST_TASK

public static final String TEST_TASK

The common name of the task which invokes tests.

See Also:

Constant Field Values

CHECK_TASK

public static final String CHECK_TASK

The common name of the task which invokes checks.

See Also:

Constant Field Values

Constructor Detail

GradleCommandLine

public GradleCommandLine(GradleDistributionManager.GradleDistribution dist,
                         GradleCommandLine cmd)

/** Creates a copy instance of the provided GradleCommandLine, but with for a specified GradleDistribution.

Parameters:

dist - the GradleDistribution for compatibility checks. null can be used for unspecified.

cmd - the command line to copy

Since:

2.23

GradleCommandLine

public GradleCommandLine(GradleCommandLine cmd)

Creates a copy instance of the provided GradleCommandLine.

Parameters:

cmd - the command line to copy

GradleCommandLine

public GradleCommandLine(GradleDistributionManager.GradleDistribution dist,
                         String... args)

Creates a command line form the specified arguments with compatibility constraint on a specified Gradle distribution.

Parameters:

dist - the GradleDistribution for compatibility checks. null can be used for unspecified.

args - the command line parameters

Since:

2.23

GradleCommandLine

public GradleCommandLine(String... args)

GradleCommandLine

public GradleCommandLine(GradleDistributionManager.GradleDistribution dist,
                         CharSequence argLine)

GradleCommandLine

public GradleCommandLine(CharSequence argLine)

Method Detail

getSupportedCommandLine

public List<String> getSupportedCommandLine()

Retrieve the command line which is actually supported to be executed from the IDE.

Returns:

the list of IDE supported arguments.

getFullCommandLine

public List<String> getFullCommandLine()

Retrieve the command line as a list of strings. This list can contain arguments which is no meaning or not supported in the IDE, like '--no-daemon' as due to the nature of Gradle tooling, Gradle daemon is always being used.

Returns:

the list of Gradle arguments.

getTasks

public Set<String> getTasks()

setTasks

public void setTasks(Collection<String> tasks)

removeTask

public void removeTask(String task)

addTask

public void addTask(String task)

hasTask

public boolean hasTask(String task)

hasFlag

public boolean hasFlag(GradleCommandLine.Flag flag)

addFlag

public void addFlag(GradleCommandLine.Flag flag)

canAdd

public boolean canAdd(GradleCommandLine.Flag flag)

canAdd

public boolean canAdd(GradleCommandLine.GradleOptionItem item)

removeFlag

public void removeFlag(GradleCommandLine.Flag flag)

setFlag

public void setFlag(GradleCommandLine.Flag flag,
                    boolean b)

addParameter

public void addParameter(GradleCommandLine.Parameter param,
                         String value)

getFirstParameter

public String getFirstParameter(GradleCommandLine.Parameter param)

hasParameter

public boolean hasParameter(GradleCommandLine.Parameter param)

getParameters

public Collection<String> getParameters(GradleCommandLine.Parameter param)

getExcludedTasks

public Set<String> getExcludedTasks()

setExcludedTasks

public void setExcludedTasks(Collection<String> excluded)

removeParameters

public void removeParameters(GradleCommandLine.Parameter param)

removeParameter

public void removeParameter(GradleCommandLine.Parameter param,
                            String value)

removeProperty

public void removeProperty(GradleCommandLine.Property prop,
                           String key)

remove

public GradleCommandLine remove(GradleCommandLine mask)

getProperty

public String getProperty(GradleCommandLine.Property type,
                          String key)

getLoglevel

public GradleCommandLine.LogLevel getLoglevel()

setLogLevel

public void setLogLevel(GradleCommandLine.LogLevel level)

addProjectProperty

public void addProjectProperty(String key,
                               String value)

addSystemProperty

public void addSystemProperty(String key,
                              String value)

getStackTrace

public GradleCommandLine.StackTrace getStackTrace()

setStackTrace

public void setStackTrace(GradleCommandLine.StackTrace st)

configure

public void configure(org.gradle.tooling.ConfigurableLauncher<?> launcher,
                      File rootDir)

Configures the given Gradle Launcher considering the options set in this command line and the Java VM arguments specified by the given project dir.

Parameters:

launcher - the Launcher instance to configure.

rootDir - can be null if the project properties for JVM arguments shall not be evaluated.

Since:

1.3

configure

public void configure(org.gradle.tooling.ConfigurableLauncher<?> launcher)

Configures the given Gradle Launcher considering the options set in this command line.

Parameters:

launcher - the Launcher instance to configure.

Since:

1.0

toString

public String toString()

Overrides:

toString in class Object

combine

public static GradleCommandLine combine(GradleCommandLine first,
                                        GradleCommandLine... layers)

getDefaultCommandLine

public static GradleCommandLine getDefaultCommandLine()