org.myire.quill.maven.impl

Class EffectivePomLoaderImpl

java.lang.Object

org.myire.quill.maven.impl.EffectivePomLoaderImpl

All Implemented Interfaces:

EffectivePomLoader

public class EffectivePomLoaderImpl
extends java.lang.Object
implements EffectivePomLoader

Implementation of EffectivePomLoader based on the Maven libraries. This class should not be loaded before the Maven libraries are available on the class path.

Constructor Summary

Constructors

Constructor and Description
EffectivePomLoaderImpl()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getArtifactId() Get the artifact ID from the effective pom.
java.util.Collection<ModuleDependencySpec>	getDependencies() Get the dependencies from the effective pom.
java.lang.String	getGroupId() Get the group ID from the effective pom.
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.
java.lang.String	getVersion() Get the version string from the effective pom.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

EffectivePomLoaderImpl

public EffectivePomLoaderImpl()

Method Detail

init

public 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.

Specified by:

init in interface EffectivePomLoader

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

public java.util.Collection<ModuleDependencySpec> getDependencies()

Get the dependencies from the effective pom. This will cause the effective pom to be loaded from the file specified in init if that hasn't been done before.

Specified by:

getDependencies in interface EffectivePomLoader

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

public java.util.Collection<RepositorySpec> getRepositories()

Get the repositories from the effective pom.

Specified by:

getRepositories in interface EffectivePomLoader

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

public RepositorySpec getLocalRepository()

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

Specified by:

getLocalRepository in interface EffectivePomLoader

Returns:

A RepositorySpec with the path to the local repository.

Throws:

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

getGroupId

public java.lang.String getGroupId()

Get the group ID from the effective pom. This will cause the effective pom to be loaded from the file specified in init if that hasn't been done before.

Specified by:

getGroupId in interface EffectivePomLoader

Returns:

The project model's group ID.

Throws:

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

getArtifactId

public java.lang.String getArtifactId()

Get the artifact ID from the effective pom. This will cause the effective pom to be loaded from the file specified in init if that hasn't been done before.

Specified by:

getArtifactId in interface EffectivePomLoader

Returns:

The project model's artifact ID.

Throws:

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

getVersion

public java.lang.String getVersion()

Get the version string from the effective pom. This will cause the effective pom to be loaded from the file specified in init if that hasn't been done before.

Specified by:

getVersion in interface EffectivePomLoader

Returns:

The project model's version string.

Throws:

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