org.myire.quill.maven

Class MavenImportExtension

java.lang.Object

org.myire.quill.common.ProjectAware

org.myire.quill.maven.MavenImportExtension

public class MavenImportExtension
extends ProjectAware

Gradle project extension for specifying a Maven settings file, a mapping from Maven scopes to Gradle configurations, and the Maven libraries to use when importing from a Maven pom file.

Constructor Summary

Constructors

Constructor and Description
MavenImportExtension(org.gradle.api.Project pProject, org.gradle.api.artifacts.Configuration pConfiguration) Create a new MavenImportExtension.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAetherVersion() Get the version of the Eclipse Aether libraries to specify in the dependencies of the mavenImport configuration.
org.gradle.api.artifacts.repositories.ArtifactRepository	getClassPathRepository() Get the temporary repository to use for resolving the dependencies of the mavenImport configuration.
org.gradle.api.file.FileCollection	getMavenClassPath() Get the class path containing the Maven related classes used by the Maven import.
java.lang.String	getMavenVersion() Get the version of the Maven libraries to specify in the dependencies of the mavenImport configuration.
java.util.Map<java.lang.String,java.lang.String>	getScopeToConfiguration() Get the mapping from Maven scope name to Gradle configuration name.
java.io.File	getSettingsFile() Get the Maven settings file to use when importing from a pom file.
java.lang.String	getWagonVersion() Get the version of the Maven Wagon libraries to specify in the dependencies of the mavenImport configuration.
void	setAetherVersion(java.lang.String pAetherVersion)
void	setClassPathRepository(java.lang.Object pRepository) Set the temporary repository to use for resolving the dependencies of the mavenImport configuration.
void	setMavenClassPath(org.gradle.api.file.FileCollection pMavenClassPath)
void	setMavenVersion(java.lang.String pMavenVersion) Set the version of the Maven libraries to specify in the dependencies of the mavenImport configuration.
void	setSettingsFile(java.lang.Object pFile) Set the Maven settings file to use when importing from a pom file.
void	setWagonVersion(java.lang.String pWagonVersion)

Methods inherited from class org.myire.quill.common.ProjectAware

getProject, getProjectLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

MavenImportExtension

public MavenImportExtension(org.gradle.api.Project pProject,
                            org.gradle.api.artifacts.Configuration pConfiguration)

Create a new MavenImportExtension.

Parameters:

pProject - The project that owns the extension.

pConfiguration - The mavenImport configuration.

Throws:

java.lang.NullPointerException - if any of the parameters is null.

Method Detail

getSettingsFile

public java.io.File getSettingsFile()

Get the Maven settings file to use when importing from a pom file. If this file is null, the default Maven settings will be used.

Returns:

The Maven settings file specification, possibly null.

setSettingsFile

public void setSettingsFile(java.lang.Object pFile)

Set the Maven settings file to use when importing from a pom file. This file will be resolved relative to the project directory.

Parameters:

pFile - The settings file, possibly null

getMavenVersion

public java.lang.String getMavenVersion()

Get the version of the Maven libraries to specify in the dependencies of the mavenImport configuration.

Returns:

The Maven version string, never null.

setMavenVersion

public void setMavenVersion(java.lang.String pMavenVersion)

Set the version of the Maven libraries to specify in the dependencies of the mavenImport configuration.

Parameters:

pMavenVersion - The Maven library version. Passing null will cause the default value to be returned from getMavenVersion.

getAetherVersion

public java.lang.String getAetherVersion()

Get the version of the Eclipse Aether libraries to specify in the dependencies of the mavenImport configuration.

Returns:

The Aether version string, never null.

setAetherVersion

public void setAetherVersion(java.lang.String pAetherVersion)

getWagonVersion

public java.lang.String getWagonVersion()

Get the version of the Maven Wagon libraries to specify in the dependencies of the mavenImport configuration.

Returns:

The Wagon version string, never null.

setWagonVersion

public void setWagonVersion(java.lang.String pWagonVersion)

getMavenClassPath

public org.gradle.api.file.FileCollection getMavenClassPath()

Get the class path containing the Maven related classes used by the Maven import. The initial value is the mavenImport configuration.

Returns:

The Maven classpath.

setMavenClassPath

public void setMavenClassPath(org.gradle.api.file.FileCollection pMavenClassPath)

getClassPathRepository

public org.gradle.api.artifacts.repositories.ArtifactRepository getClassPathRepository()

Get the temporary repository to use for resolving the dependencies of the mavenImport configuration.

Returns:

The default repository, possibly null.

setClassPathRepository

public void setClassPathRepository(java.lang.Object pRepository)

Set the temporary repository to use for resolving the dependencies of the mavenImport configuration.

Parameters:

pRepository - An ArtifactRepository instance or a Closure or Supplier that returns an ArtifactRepository instance.

getScopeToConfiguration

public java.util.Map<java.lang.String,java.lang.String> getScopeToConfiguration()

Get the mapping from Maven scope name to Gradle configuration name.

Returns:

The scope to configuration mapping. The returned map is the instance used by the extension; modifications to it may affect the behaviour of other callers.