org.myire.quill.ivy

Class IvyImportExtension

java.lang.Object

org.myire.quill.common.ProjectAware

org.myire.quill.ivy.IvyImportExtension

public class IvyImportExtension
extends ProjectAware

Gradle project extension for specifying an Ivy settings file and the Ivy libraries to use when importing from an Ivy file.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
org.gradle.api.file.FileCollection	getIvyClassPath() Get the class path containing the Ivy related classes used by the Ivy import.
java.lang.String	getIvyVersion() Get the version of the Ivy libraries to use when importing from an Ivy file.
java.io.File	getSettingsFile() Get the Ivy settings file to use when importing from an Ivy file.
java.lang.String	getWildcardConfiguration() Get the name of the configuration to map the wildcard Ivy configuration to.
void	setIvyClassPath(org.gradle.api.file.FileCollection pIvyClassPath)
void	setIvyVersion(java.lang.String pIvyVersion) Set the version of the Ivy libraries to use when importing from an Ivy file.
void	setSettingsFile(java.lang.Object pFile) Set the Ivy settings file to use when importing from an Ivy file.
void	setWildcardConfiguration(java.lang.String pWildcardConfiguration) Set the name of the configuration to map the wildcard Ivy configuration to.

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

IvyImportExtension

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

Create a new IvyImportExtension.

Parameters:

pProject - The project that owns the extension.

pConfiguration - The ivyImport configuration.

Throws:

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

Method Detail

getSettingsFile

public java.io.File getSettingsFile()

Get the Ivy settings file to use when importing from an Ivy file. If this file is null, the default Ivy settings will be used.

Returns:

The Ivy settings file specification, possibly null.

setSettingsFile

public void setSettingsFile(java.lang.Object pFile)

Set the Ivy settings file to use when importing from an Ivy file. This file will be resolved relative to the project directory.

Parameters:

pFile - The settings file, possibly null

getIvyVersion

public java.lang.String getIvyVersion()

Get the version of the Ivy libraries to use when importing from an Ivy file.

Returns:

The Ivy version string, never null.

setIvyVersion

public void setIvyVersion(java.lang.String pIvyVersion)

Set the version of the Ivy libraries to use when importing from an Ivy file.

Parameters:

pIvyVersion - The Ivy library version. Passing null will cause the default value to be returned from getIvyVersion.

getIvyClassPath

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

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

Returns:

The Ivy classpath.

setIvyClassPath

public void setIvyClassPath(org.gradle.api.file.FileCollection pIvyClassPath)

getWildcardConfiguration

public java.lang.String getWildcardConfiguration()

Get the name of the configuration to map the wildcard Ivy configuration to.

Returns:

The wildcard configuration string, never null.

setWildcardConfiguration

public void setWildcardConfiguration(java.lang.String pWildcardConfiguration)

Set the name of the configuration to map the wildcard Ivy configuration to.

Parameters:

pWildcardConfiguration - The wildcard configuration name. Passing null will cause the default value to be returned from getWildcardConfiguration.