org.myire.quill.maven

Interface EffectivePomLoader

All Known Implementing Classes:

EffectivePomLoaderImpl

public interface EffectivePomLoader

An EffectivePomLoader loads the effective pom from a Maven pom file and retrieves (parts of) its contents.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getArtifactId() Get the artifact ID from the effective pom, possibly loading it first.
java.util.Collection<ModuleDependencySpec>	getDependencies() Get the dependencies from the effective pom, possibly loading it first.
java.lang.String	getGroupId() Get the group ID from the effective pom, possibly loading it first.
RepositorySpec	getLocalRepository() Get the local repository from the settings file, possibly loading it first.
java.util.Collection<RepositorySpec>	getRepositories() Get the repositories from the effective pom, possibly loading it first.
java.lang.String	getVersion() Get the version string from the effective pom, possibly loading it first.
void	init(java.io.File pPomFile, java.io.File pSettingsFile) Specify the pom file to load and any settings file to apply when loading the effective pom.

Method Detail

init

void init(java.io.File pPomFile,
          java.io.File pSettingsFile)

Specify the pom file to load and any settings file to apply when loading the effective pom.

Parameters:

pPomFile - The pom file.

pSettingsFile - Any settings file to use. If null the default Maven settings will be used.

Throws:

java.lang.NullPointerException - if pPomFile is null.

getDependencies

java.util.Collection<ModuleDependencySpec> getDependencies()

Get the dependencies from the effective pom, possibly loading it first.

Returns:

A collection of ModuleDependencySpec, one for each dependency in the effective pom. The returned collection will never be null but may be empty. The Maven scope names will be used as configuration names in the specs.

Throws:

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

getRepositories

java.util.Collection<RepositorySpec> getRepositories()

Get the repositories from the effective pom, possibly loading it first.

Returns:

A collection of RepositorySpec, one for each repository in the pom. The returned collection will never be null but may be empty.

Throws:

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

getLocalRepository

RepositorySpec getLocalRepository()

Get the local repository from the settings file, possibly loading it first.

Returns:

A RepositorySpec with the path to the local repository.

Throws:

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

getGroupId

java.lang.String getGroupId()

Get the group ID from the effective pom, possibly loading it first.

Returns:

The project model's group ID.

Throws:

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

getArtifactId

java.lang.String getArtifactId()

Get the artifact ID from the effective pom, possibly loading it first.

Returns:

The project model's artifact ID.

Throws:

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

getVersion

java.lang.String getVersion()

Get the version string from the effective pom, possibly loading it first.

Returns:

The project model's version string.

Throws:

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