Class BaseProject
- Direct Known Subclasses:
Project
- Since:
- 1.5.20
-
Field Summary
Modifier and TypeFieldDescriptionprotected String
The base name that is used for creating archives.protected Boolean
Indicates whether dependencies should be automatically downloaded and purged when changes are detected.protected File
The bld build directory.protected File
The build directory.protected File
The dist build directory.protected File
The javadoc build directory.protected File
The main build directory.protected File
The templates build directory.protected File
The test build directory.protected DependencyScopes
The project's dependencies.protected Boolean
Indicates whether javadocs should be downloaded for the dependencies.protected Boolean
Indicates whether sources should be downloaded for the dependencies.protected String
The filename to use for the main jar archive creation.protected String
The filename to use for the javadoc jar archive creation.protected Integer
The project's Java release version for compilation.protected String
The tool that is used for running the java main class.protected File
The compile scope lib directory.protected File
The lib directory.protected File
The provided scope lib directory.protected File
The runtime scope lib directory.protected File
The standalone scope lib directory.protected File
The standalone scope lib directory.protected String
The project's main class.protected String
The project's name.protected String
The project's package.protected List<Repository>
The project's repositories for dependency resolution.protected String
The filename to use for the sources jar archive creation.protected File
The bld source code directory.protected File
The bld java source code directory.protected File
The bld resources source code directory.protected File
The source code directory.protected File
The main source code directory.protected File
The main java source code directory.protected File
The main resources source code directory.protected File
The main template resources source code directory.protected File
The test source code directory.protected File
The test java source code directory.protected File
The test resources source code directory.protected String
The filename to use for the uber jar archive creation.protected String
The main class to run the UberJar with.protected VersionNumber
The project's version.protected File
The work directory of the project.Fields inherited from class rife.bld.BuildExecutor
BLD_PROPERTIES, BLD_USER_DIR, LOCAL_PROPERTIES, RIFE2_USER_DIR, showStacktrace
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionReturns the base name that is used for creating archives.Returns the artifact retriever that is used.boolean
Indicates whether dependencies should be automatically downloaded and purged when changes are detected.Returns the project bld build directory.Returns the project build directory.Returns the project dist build directory.Returns the project javadoc build directory.Returns the project main build directory.Returns the project templates build directory.Returns the project test build directory.void
clean()
Standard build command, cleans the build files.Retrieves the project's default clean operation.void
compile()
Standard build command, compiles the project.Returns all the jar files that are in the compile scope classpath.Returns all the classpath entries for compiling the main sources.Retrieves the project's default compile operation.Returns all the classpath entries for compiling the test sources.void
Creates the project build structure based on the directories that are specified in the other methods.void
Creates the project structure based on the directories that are specified in the other methods.Returns the project's dependencies.dependency
(String description) Creates a new dependency instance from a string representation.dependency
(String groupId, String artifactId) Creates a new dependency instance.dependency
(String groupId, String artifactId, String version) Creates a new dependency instance.dependency
(String groupId, String artifactId, String version, String classifier) Creates a new dependency instance.Creates a new dependency instance.dependency
(String groupId, String artifactId, VersionNumber version) Creates a new dependency instance.dependency
(String groupId, String artifactId, VersionNumber version, String classifier) Creates a new dependency instance.dependency
(String groupId, String artifactId, VersionNumber version, String classifier, String type) Creates a new dependency instance.void
Standard build command, output the dependency tree.Retrieves the project's default dependency tree operation.void
download()
Standard build command, downloads all dependencies of the project.boolean
Returns whether javadocs should be downloaded for the dependencies.Retrieves the project's default download operation.boolean
Returns whether sources should be downloaded for the dependencies.int
Execute the build commands from the provided arguments.void
Executes download and purge commands automatically when theautoDownloadPurge
flag is set and changes have been detected.Returns the jar file of the RIFE2 instrumentation agent that should be used.Returns the filename to use for the main jar archive creation.Returns the filename to use for the javadoc jar archive creation.Returns the java release targets for this project.javaTool()
Returns the tool that is used for running the java main class.final File
Returns thelib/bld
directory relative toworkDirectory()
.Returns the project compile scope lib directory.Returns the project lib directory.Returns the project provided scope lib directory.Returns the project runtime scope lib directory.Returns the project standalone scope lib directory.Returns the project test scope lib directory.Creates a local dependency instance.Returns the project's main class.Returns all a list with all the main Java source files.name()
Returns the project's name.pkg()
Returns the project's package.void
Standard build command, outputs the version of the build system.Returns all the jar files that are in the provided scope classpath.Retrieves the project's default publish operation.void
purge()
Standard build command, purges all unused artifacts from the project.Retrieves the project's default purge operation.Returns the list of repositories for this project.void
repositories
(Repository... repositories) Adds repositories to this project.repository
(String locationOrName) Creates a new repository instance.repository
(String location, String username, String password) Creates a new repository instance with basic username and password authentication.void
run()
Standard build command, runs the project.Returns all the classpath entries for running the application.Retrieves the project's default run operation.Returns all the jar files that are in the runtime scope classpath.Retrieves the dependency set for a particular scope, initializing it if it doesn't exist yet.snapshot
(int major) Creates a new snapshot version instance.snapshot
(int major, int minor) Creates a new snapshot version instance.snapshot
(int major, int minor, int revision) Creates a new snapshot version instance.Returns the filename to use for the sources jar archive creation.Returns the project bld source code directory.Returns the project bld java source code directory.Returns the project bld resources source code directory.Returns the project source code directory.Returns the project main source code directory.Returns the project main java source code directory.Returns the project main resources source code directory.Returns the project main template resources source code directory.Returns the project test source code directory.Returns the project test java source code directory.Returns the project test resources source code directory.Returns all the jar files that are in the standalone scope classpath.void
test()
Standard build command, tests the project.Returns all the classpath entries for testing the application.Returns all the jar files that are in the test scope classpath.TestOperation<?,
?> Retrieves the project's default test operation.Returns all a list with all the test Java source files.Returns the filename to use for the uber jar archive creation.Returns main class to run the UberJar with.void
updates()
Standard build command, checks for updates of the project dependencies.Retrieves the project's default updates operation.void
useRife2Agent
(VersionNumber version) Includes the RIFE2 instrumentation agent as a runtime dependency, and activates it for run and test commands.boolean
Indicates whether the RIFE2 instrumentation agent should be used.version()
Returns the project's version.version
(int major) Creates a new version instance.version
(int major, int minor) Creates a new version instance.version
(int major, int minor, int revision) Creates a new version instance.Creates a new version instance.Creates a new version instance.Retrieves the project's default version operation.Returns the work directory of the project.Methods inherited from class rife.bld.BuildExecutor
arguments, buildAliases, buildCommands, executeCommand, exitStatus, exitStatus, getCurrentCommandDefinition, getCurrentCommandName, hasProperty, help, properties, property, property, setupProperties, start
-
Field Details
-
workDirectory
The work directory of the project.- Since:
- 1.5
- See Also:
-
pkg
The project's package.- Since:
- 1.5
- See Also:
-
name
The project's name.- Since:
- 1.5
- See Also:
-
version
The project's version.- Since:
- 1.5
- See Also:
-
mainClass
The project's main class.- Since:
- 1.5
- See Also:
-
repositories
The project's repositories for dependency resolution.- Since:
- 1.5
- See Also:
-
dependencies
The project's dependencies.- Since:
- 1.5
- See Also:
-
javaRelease
The project's Java release version for compilation.- Since:
- 1.5.6
- See Also:
-
javaTool
The tool that is used for running the java main class.- Since:
- 1.5
- See Also:
-
archiveBaseName
The base name that is used for creating archives.- Since:
- 1.5
- See Also:
-
jarFileName
The filename to use for the main jar archive creation.- Since:
- 1.5
- See Also:
-
sourcesJarFileName
The filename to use for the sources jar archive creation.- Since:
- 1.5.10
- See Also:
-
javadocJarFileName
The filename to use for the javadoc jar archive creation.- Since:
- 1.5.10
- See Also:
-
uberJarFileName
The filename to use for the uber jar archive creation.- Since:
- 1.5
- See Also:
-
uberJarMainClass
The main class to run the UberJar with.- Since:
- 1.5
- See Also:
-
autoDownloadPurge
Indicates whether dependencies should be automatically downloaded and purged when changes are detected.- Since:
- 1.5.16
- See Also:
-
downloadSources
Indicates whether sources should be downloaded for the dependencies.- Since:
- 1.5.6
- See Also:
-
downloadJavadoc
Indicates whether javadocs should be downloaded for the dependencies.- Since:
- 1.5.6
- See Also:
-
srcDirectory
The source code directory.- Since:
- 1.5
- See Also:
-
srcBldDirectory
The bld source code directory.- Since:
- 1.5
- See Also:
-
srcBldJavaDirectory
The bld java source code directory.- Since:
- 1.5
- See Also:
-
srcBldResourcesDirectory
The bld resources source code directory.- Since:
- 1.5.6
- See Also:
-
srcMainDirectory
The main source code directory.- Since:
- 1.5
- See Also:
-
srcMainJavaDirectory
The main java source code directory.- Since:
- 1.5
- See Also:
-
srcMainResourcesDirectory
The main resources source code directory.- Since:
- 1.5
- See Also:
-
srcMainResourcesTemplatesDirectory
The main template resources source code directory.- Since:
- 1.5
- See Also:
-
srcTestDirectory
The test source code directory.- Since:
- 1.5
- See Also:
-
srcTestJavaDirectory
The test java source code directory.- Since:
- 1.5
- See Also:
-
srcTestResourcesDirectory
The test resources source code directory.- Since:
- 1.5.18
- See Also:
-
libDirectory
The lib directory.- Since:
- 1.5
- See Also:
-
libCompileDirectory
The compile scope lib directory.- Since:
- 1.5
- See Also:
-
libProvidedDirectory
The provided scope lib directory.- Since:
- 1.8
- See Also:
-
libRuntimeDirectory
The runtime scope lib directory.- Since:
- 1.5
- See Also:
-
libStandaloneDirectory
The standalone scope lib directory.- Since:
- 1.5
- See Also:
-
libTestDirectory
The standalone scope lib directory.- Since:
- 1.5
- See Also:
-
buildDirectory
The build directory.- Since:
- 1.5
- See Also:
-
buildBldDirectory
The bld build directory.- Since:
- 1.5
- See Also:
-
buildDistDirectory
The dist build directory.- Since:
- 1.5
- See Also:
-
buildJavadocDirectory
The javadoc build directory.- Since:
- 1.5.10
- See Also:
-
buildMainDirectory
The main build directory.- Since:
- 1.5
- See Also:
-
buildTemplatesDirectory
The templates build directory.- Since:
- 1.5
- See Also:
-
buildTestDirectory
The test build directory.- Since:
- 1.5
- See Also:
-
-
Constructor Details
-
BaseProject
public BaseProject()
-
-
Method Details
-
artifactRetriever
Returns the artifact retriever that is used.- Returns:
- the artifact retriever
- Since:
- 1.5.21
-
cleanOperation
Retrieves the project's default clean operation.- Returns:
- the default clean operation instance
- Since:
- 1.5.18
-
compileOperation
Retrieves the project's default compile operation.- Returns:
- the default compile operation instance
- Since:
- 1.5.18
-
dependencyTreeOperation
Retrieves the project's default dependency tree operation.- Returns:
- the default dependency tree operation instance
- Since:
- 1.5.21
-
downloadOperation
Retrieves the project's default download operation.- Returns:
- the default download operation instance
- Since:
- 1.5.18
-
publishOperation
Retrieves the project's default publish operation.- Returns:
- the default publish operation instance
- Since:
- 1.5.18
-
purgeOperation
Retrieves the project's default purge operation.- Returns:
- the default purge operation instance
- Since:
- 1.5.18
-
runOperation
Retrieves the project's default run operation.- Returns:
- the default run operation instance
- Since:
- 1.5.18
-
testOperation
Retrieves the project's default test operation.- Returns:
- the default test operation instance
- Since:
- 1.5.18
-
updatesOperation
Retrieves the project's default updates operation.- Returns:
- the default updates operation instance
- Since:
- 1.5.18
-
versionOperation
Retrieves the project's default version operation.- Returns:
- the default version operation instance
- Since:
- 1.5.18
-
clean
Standard build command, cleans the build files.- Throws:
Exception
- Since:
- 1.5
-
compile
Standard build command, compiles the project.- Throws:
Exception
- Since:
- 1.5
-
dependencyTree
@BuildCommand(value="dependency-tree", help=DependencyTreeHelp.class) public void dependencyTree() throws ExceptionStandard build command, output the dependency tree.- Throws:
Exception
- Since:
- 1.5.21
-
download
Standard build command, downloads all dependencies of the project.- Throws:
Exception
- Since:
- 1.5
-
purge
Standard build command, purges all unused artifacts from the project.- Throws:
Exception
- Since:
- 1.5
-
run
Standard build command, runs the project.- Throws:
Exception
- Since:
- 1.5
-
test
Standard build command, tests the project.- Throws:
Exception
- Since:
- 1.5
-
printVersion
Standard build command, outputs the version of the build system.- Throws:
Exception
- Since:
- 1.5.2
-
updates
Standard build command, checks for updates of the project dependencies.- Throws:
Exception
- Since:
- 1.5
-
useRife2Agent
Includes the RIFE2 instrumentation agent as a runtime dependency, and activates it for run and test commands.- Parameters:
version
- the version of the instrumentation agent to use- Since:
- 1.5.5
-
usesRife2Agent
public boolean usesRife2Agent()Indicates whether the RIFE2 instrumentation agent should be used.- Returns:
true
if the RIFE2 instrumentation agent should be used; orfalse
otherwise- Since:
- 1.5.18
-
getRife2AgentFile
Returns the jar file of the RIFE2 instrumentation agent that should be used.- Returns:
- the jar file of the RIFE2 instrumentation agent; or
null
if no agent should be used - Since:
- 1.5.18
-
repository
Creates a new repository instance.Instead of providing the repository location, it's also possible to provide a name that will be used to look up the repository credentials in the hierarchical properties.
For instance, using the name
myrepo
will look for the following properties:
bld.repo.myrepo
bld.repo.myrepo.username
(optional)
bld.repo.myrepo.password
(optional)- Parameters:
locationOrName
- the repository location or name- Returns:
- a newly created
Repository
instance - Since:
- 1.5.6
-
repository
Creates a new repository instance with basic username and password authentication.- Parameters:
location
- the repository locationusername
- the repository usernamepassword
- the repository password- Returns:
- a newly created
Repository
instance - Since:
- 1.5.7
-
version
Creates a new version instance.- Parameters:
major
- the major component of the version number- Returns:
- a newly created
VersionNumber
instance - Since:
- 1.5
-
version
Creates a new version instance.- Parameters:
major
- the major component of the version numberminor
- the minor component of the version number- Returns:
- a newly created
VersionNumber
instance - Since:
- 1.5
-
version
Creates a new version instance.- Parameters:
major
- the major component of the version numberminor
- the minor component of the version numberrevision
- the revision component of the version number- Returns:
- a newly created
VersionNumber
instance - Since:
- 1.5
-
version
Creates a new version instance.- Parameters:
major
- the major component of the version numberminor
- the minor component of the version numberrevision
- the revision component of the version numberqualifier
- the qualifier component of the version number- Returns:
- a newly created
VersionNumber
instance - Since:
- 1.5
-
version
Creates a new version instance.- Parameters:
description
- the textual description of the version number- Returns:
- a newly created
VersionNumber
instance; orVersionNumber.UNKNOWN
if the description couldn't be parsed - Since:
- 1.5
-
snapshot
Creates a new snapshot version instance.- Parameters:
major
- the major component of the snapshot version number- Returns:
- a newly created snapshot
VersionNumber
instance - Since:
- 1.7.4
-
snapshot
Creates a new snapshot version instance.- Parameters:
major
- the major component of the snapshot version numberminor
- the minor component of the snapshot version number- Returns:
- a newly created snapshot
VersionNumber
instance - Since:
- 1.7.4
-
snapshot
Creates a new snapshot version instance.- Parameters:
major
- the major component of the snapshot version numberminor
- the minor component of the snapshot version numberrevision
- the revision component of the snapshot version number- Returns:
- a newly created snapshot
VersionNumber
instance - Since:
- 1.7.4
-
scope
Retrieves the dependency set for a particular scope, initializing it if it doesn't exist yet.- Parameters:
scope
- the scope to retrieve dependencies for- Returns:
- the scope's dependency set
- Since:
- 1.5
-
dependency
Creates a new dependency instance.- Parameters:
groupId
- the dependency group identifierartifactId
- the dependency artifact identifier- Returns:
- a newly created
Dependency
instance - Since:
- 1.5
-
dependency
Creates a new dependency instance.- Parameters:
groupId
- the dependency group identifierartifactId
- the dependency artifact identifierversion
- the dependency version- Returns:
- a newly created
Dependency
instance - Since:
- 1.5.16
-
dependency
Creates a new dependency instance.- Parameters:
groupId
- the dependency group identifierartifactId
- the dependency artifact identifierversion
- the dependency versionclassifier
- the dependency classifier- Returns:
- a newly created
Dependency
instance - Since:
- 1.5.16
-
dependency
public Dependency dependency(String groupId, String artifactId, String version, String classifier, String type) Creates a new dependency instance.- Parameters:
groupId
- the dependency group identifierartifactId
- the dependency artifact identifierversion
- the dependency versionclassifier
- the dependency classifiertype
- the dependency type- Returns:
- a newly created
Dependency
instance - Since:
- 1.5.16
-
dependency
Creates a new dependency instance.- Parameters:
groupId
- the dependency group identifierartifactId
- the dependency artifact identifierversion
- the dependency version- Returns:
- a newly created
Dependency
instance - Since:
- 1.5
-
dependency
public Dependency dependency(String groupId, String artifactId, VersionNumber version, String classifier) Creates a new dependency instance.- Parameters:
groupId
- the dependency group identifierartifactId
- the dependency artifact identifierversion
- the dependency versionclassifier
- the dependency classifier- Returns:
- a newly created
Dependency
instance - Since:
- 1.5
-
dependency
public Dependency dependency(String groupId, String artifactId, VersionNumber version, String classifier, String type) Creates a new dependency instance.- Parameters:
groupId
- the dependency group identifierartifactId
- the dependency artifact identifierversion
- the dependency versionclassifier
- the dependency classifiertype
- the dependency type- Returns:
- a newly created
Dependency
instance - Since:
- 1.5
-
dependency
Creates a new dependency instance from a string representation. The format isgroupId:artifactId:version:classifier@type
. Theversion
,classifier
andtype
are optional.If the string can't be successfully parsed,
null
will be returned.- Parameters:
description
- the dependency string to parse- Returns:
- a parsed instance of
Dependency
; ornull
when the string couldn't be parsed - Since:
- 1.5.2
-
local
Creates a local dependency instance.If the local dependency points to a directory, it will be scanned for jar files.
- Parameters:
path
- the file system path of the local dependency- Since:
- 1.5.2
-
workDirectory
Returns the work directory of the project. Defaults to this process's user working directory, which when running through the bld wrapper corresponds to the top-level project directory.- Overrides:
workDirectory
in classBuildExecutor
- Since:
- 1.5
-
srcDirectory
Returns the project source code directory. Defaults to"src"
relative toworkDirectory()
.- Since:
- 1.5
-
srcBldDirectory
Returns the project bld source code directory. Defaults to"bld"
relative tosrcDirectory()
.- Since:
- 1.5
-
srcBldJavaDirectory
Returns the project bld java source code directory. Defaults to"java"
relative tosrcBldDirectory()
.- Since:
- 1.5
-
srcBldResourcesDirectory
Returns the project bld resources source code directory. Defaults to"resources"
relative tosrcMainDirectory()
.- Since:
- 1.5.5
-
srcMainDirectory
Returns the project main source code directory. Defaults to"main"
relative tosrcDirectory()
.- Since:
- 1.5
-
srcMainJavaDirectory
Returns the project main java source code directory. Defaults to"java"
relative tosrcMainDirectory()
.- Since:
- 1.5
-
srcMainResourcesDirectory
Returns the project main resources source code directory. Defaults to"resources"
relative tosrcMainDirectory()
.- Since:
- 1.5
-
srcMainResourcesTemplatesDirectory
Returns the project main template resources source code directory. Defaults to"templates"
relative tosrcMainResourcesDirectory()
.- Since:
- 1.5
-
srcTestDirectory
Returns the project test source code directory. Defaults to"test"
relative tosrcDirectory()
.- Since:
- 1.5
-
srcTestResourcesDirectory
Returns the project test resources source code directory. Defaults to"resources"
relative tosrcTestDirectory()
.- Since:
- 1.5.18
-
srcTestJavaDirectory
Returns the project test java source code directory. Defaults to"java"
relative tosrcTestDirectory()
.- Since:
- 1.5
-
libDirectory
Returns the project lib directory. Defaults to"lib"
relative toworkDirectory()
.- Since:
- 1.5
-
libBldDirectory
Returns thelib/bld
directory relative toworkDirectory()
.- Since:
- 1.5
-
libCompileDirectory
Returns the project compile scope lib directory. Defaults to"compile"
relative tolibDirectory()
.- Since:
- 1.5
-
libProvidedDirectory
Returns the project provided scope lib directory. Defaults to"provided"
relative tolibDirectory()
.- Since:
- 1.8
-
libRuntimeDirectory
Returns the project runtime scope lib directory. Defaults to"runtime"
relative tolibDirectory()
.- Since:
- 1.5
-
libStandaloneDirectory
Returns the project standalone scope lib directory. Defaults tonull
.- Since:
- 1.5
-
libTestDirectory
Returns the project test scope lib directory. Defaults to"test"
relative tolibDirectory()
.- Since:
- 1.5
-
buildDirectory
Returns the project build directory. Defaults to"build"
relative toworkDirectory()
.- Since:
- 1.5
-
buildBldDirectory
Returns the project bld build directory. Defaults to"bld"
relative tobuildDirectory()
.- Since:
- 1.5
-
buildDistDirectory
Returns the project dist build directory. Defaults to"dist"
relative tobuildDirectory()
.- Since:
- 1.5
-
buildJavadocDirectory
Returns the project javadoc build directory. Defaults to"javadoc"
relative tobuildDirectory()
.- Since:
- 1.5.10
-
buildMainDirectory
Returns the project main build directory. Defaults to"main"
relative tobuildDirectory()
.- Since:
- 1.5
-
buildTemplatesDirectory
Returns the project templates build directory. Defaults tobuildMainDirectory()
.- Since:
- 1.5
-
buildTestDirectory
Returns the project test build directory. Defaults to"test"
relative tobuildDirectory()
.- Since:
- 1.5
-
createProjectStructure
public void createProjectStructure()Creates the project structure based on the directories that are specified in the other methods.- Since:
- 1.5
-
createBuildStructure
public void createBuildStructure()Creates the project build structure based on the directories that are specified in the other methods.- Since:
- 1.5
-
pkg
Returns the project's package.- Since:
- 1.5
-
name
Returns the project's name.- Since:
- 1.5
-
version
Returns the project's version.- Since:
- 1.5
-
mainClass
Returns the project's main class.- Since:
- 1.5
-
repositories
Returns the list of repositories for this project.This list can be modified to change the repositories that the project uses.
- Since:
- 1.5
-
repositories
Adds repositories to this project.- Parameters:
repositories
- the repositories to add- Since:
- 1.5.6
-
dependencies
Returns the project's dependencies.This collection can be modified to change the dependencies that the project uses.
- Since:
- 1.5
-
javaRelease
Returns the java release targets for this project.- Since:
- 1.5.18
-
javaTool
Returns the tool that is used for running the java main class.- Since:
- 1.5
-
archiveBaseName
Returns the base name that is used for creating archives. By default, this returns the lower-cased project name.- Since:
- 1.5
-
jarFileName
Returns the filename to use for the main jar archive creation. By default, appends the version and thejar
extension to thearchiveBaseName()
.- Since:
- 1.5
-
sourcesJarFileName
Returns the filename to use for the sources jar archive creation. By default, appends the version,"sources"
and thejar
extension to thearchiveBaseName()
.- Since:
- 1.5.10
-
javadocJarFileName
Returns the filename to use for the javadoc jar archive creation. By default, appends the version,"javadoc"
and thejar
extension to thearchiveBaseName()
.- Since:
- 1.5.10
-
uberJarFileName
Returns the filename to use for the uber jar archive creation. By default, appends the version, the"-uber"
suffix and thejar
extension to thearchiveBaseName()
.- Since:
- 1.5
-
uberJarMainClass
Returns main class to run the UberJar with. By default, returns the same asmainClass()
.- Since:
- 1.5
-
autoDownloadPurge
public boolean autoDownloadPurge()Indicates whether dependencies should be automatically downloaded and purged when changes are detected. By default, returnsfalse
.- Since:
- 1.5.6
-
downloadSources
public boolean downloadSources()Returns whether sources should be downloaded for the dependencies. By default, returnsfalse
.- Since:
- 1.5.6
-
downloadJavadoc
public boolean downloadJavadoc()Returns whether javadocs should be downloaded for the dependencies. By default, returnsfalse
.- Since:
- 1.5.6
-
mainSourceFiles
Returns all a list with all the main Java source files.- Since:
- 1.5
-
testSourceFiles
Returns all a list with all the test Java source files.- Since:
- 1.5
-
compileClasspathJars
Returns all the jar files that are in the compile scope classpath.By default, this collects all the jar files in the
libCompileDirectory()
and adds all the jar files from the compile scope local dependencies.- Since:
- 1.5
-
providedClasspathJars
Returns all the jar files that are in the provided scope classpath.By default, this collects all the jar files in the
libProvidedDirectory()
and adds all the jar files from the provided scope local dependencies.- Since:
- 1.8
-
runtimeClasspathJars
Returns all the jar files that are in the runtime scope classpath.By default, this collects all the jar files in the
libRuntimeDirectory()
and adds all the jar files from the runtime scope local dependencies.- Since:
- 1.5
-
standaloneClasspathJars
Returns all the jar files that are in the standalone scope classpath.By default, this collects all the jar files in the
libStandaloneDirectory()
and adds all the jar files from the standalone scope local dependencies.- Since:
- 1.5
-
testClasspathJars
Returns all the jar files that are in the test scope classpath.By default, this collects all the jar files in the
libTestDirectory()
and adds all the jar files from the test scope local dependencies.- Since:
- 1.5
-
compileMainClasspath
Returns all the classpath entries for compiling the main sources.By default, this converts the files from
compileClasspathJars()
to absolute paths.- Since:
- 1.5
-
compileTestClasspath
Returns all the classpath entries for compiling the test sources.By default, this converts the files from
compileClasspathJars()
andtestClasspathJars()
to absolute paths, as well as thebuildMainDirectory()
- Since:
- 1.5
-
runClasspath
Returns all the classpath entries for running the application.By default, this converts the files from
compileClasspathJars()
,runtimeClasspathJars()
andstandaloneClasspathJars()
to absolute paths, as well as thesrcMainResourcesDirectory()
andbuildMainDirectory()
- Since:
- 1.5
-
testClasspath
Returns all the classpath entries for testing the application.By default, this converts the files from
compileClasspathJars()
,runtimeClasspathJars()
andtestClasspathJars()
to absolute paths, as well as thesrcMainResourcesDirectory()
,buildMainDirectory()
andbuildTestDirectory()
- Since:
- 1.5
-
executeAutoDownloadPurge
Executes download and purge commands automatically when theautoDownloadPurge
flag is set and changes have been detected.- Throws:
Exception
- when an exception occurs during the auto download purge operation- Since:
- 1.6.0
-
execute
Description copied from class:BuildExecutor
Execute the build commands from the provided arguments.While the build is executing, the arguments can be retrieved using
BuildExecutor.arguments()
.- Overrides:
execute
in classBuildExecutor
- Parameters:
arguments
- the arguments to execute the build with- Returns:
- the exist status
-