org.myire.quill.ivy

Interface IvyModuleLoader

All Known Implementing Classes:

IvyModuleLoaderImpl

public interface IvyModuleLoader

An IvyModuleLoader loads an Ivy module from an Ivy file and retrieves (parts of) its contents.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<ConfigurationSpec>	getConfigurations() Get the configurations from the Ivy module, possibly loading the file first.
java.util.Collection<ModuleDependencySpec>	getDependencies() Get the dependencies from the Ivy module, possibly loading the file first.
java.lang.String	getModuleName() Get the value of the module attribute from the Ivy module's info section, possibly loading the file first.
java.lang.String	getOrganisation() Get the value of the organisation attribute from the Ivy module's info section, possibly loading the file first.
java.lang.String	getRevision() Get the value of the revision attribute from the Ivy module's info section, possibly loading the file first.
void	init(java.io.File pIvyModuleFile, java.io.File pIvySettingsFile) Specify the Ivy module file to load and any settings file to apply when loading the file.

Method Detail

init

void init(java.io.File pIvyModuleFile,
          java.io.File pIvySettingsFile)

Specify the Ivy module file to load and any settings file to apply when loading the file.

Parameters:

pIvyModuleFile - The Ivy module file.

pIvySettingsFile - Any settings file to use. If null, the default Ivy settings will be used.

Throws:

java.lang.NullPointerException - if pIvyModuleFile is null.

getDependencies

java.util.Collection<ModuleDependencySpec> getDependencies()

Get the dependencies from the Ivy module, possibly loading the file first.

Returns:

A collection of ModuleDependencySpec, one for each dependency in the Ivy module. The returned collection will never be null but may be empty.

Throws:

org.gradle.api.GradleException - if loading the Ivy file fails.

getConfigurations

java.util.Collection<ConfigurationSpec> getConfigurations()

Get the configurations from the Ivy module, possibly loading the file first.

Returns:

A collection of ConfigurationSpec, one for each configuration in the Ivy module. The returned collection will never be null but may be empty.

Throws:

org.gradle.api.GradleException - if loading the Ivy file fails.

getOrganisation

java.lang.String getOrganisation()

Get the value of the organisation attribute from the Ivy module's info section, possibly loading the file first.

Returns:

The organisation.

Throws:

org.gradle.api.GradleException - if loading the Ivy file fails.

getModuleName

java.lang.String getModuleName()

Get the value of the module attribute from the Ivy module's info section, possibly loading the file first.

Returns:

The module name.

Throws:

org.gradle.api.GradleException - if loading the Ivy file fails.

getRevision

java.lang.String getRevision()

Get the value of the revision attribute from the Ivy module's info section, possibly loading the file first.

Returns:

The revision.

Throws:

org.gradle.api.GradleException - if loading the Ivy file fails.