org.mevenide.environment
Class LocationFinderAggregator

java.lang.Object
  org.mevenide.environment.AbstractLocationFinder
      org.mevenide.environment.LocationFinderAggregator

All Implemented Interfaces:

ILocationFinder

public class LocationFinderAggregator
extends AbstractLocationFinder

Author:

Gilles Dodinet (gdodinet@wanadoo.fr)

Field Summary

Fields inherited from interface org.mevenide.environment.ILocationFinder

FOREHEAD_CONF_FILE, JAVA_HOME, MAVEN_HOME, MAVEN_HOME_LOCAL, MAVEN_PLUGIN_DIR, MAVEN_PLUGIN_UNPACKED_DIR, MAVEN_PLUGIN_USER_DIR, MAVEN_REPO_LOCAL, USER_HOME

Constructor Summary

LocationFinderAggregator(IQueryContext queryContext)
default constructor for the aggregator

LocationFinderAggregator(IQueryContext queryContext, ILocationFinder custom)
default constructor for the aggregator

Method Summary

java.lang.String	getJavaHome() The directory on the local machine that contains the JDK.
java.lang.String	getMavenHome() The directory on the local machine that contains Maven.
java.lang.String	getMavenLocalHome() The directory on the local machine Maven uses to write user specific details to, such as expanded plugins and cache data.
java.lang.String	getMavenLocalRepository() The repository on the local machine Maven should use to store downloaded artifacts (jars etc).
java.lang.String	getMavenPluginsDir() Where Maven expands installed plugins for processing.
java.lang.String	getPluginJarsDir() Where Maven can find it's plugins.
java.lang.String	getUserHome() The user's home directory on the local machine.
java.lang.String	getUserPluginsDir() Where Maven can find plugins for this user only.
void	setCustomLocationFinder(ILocationFinder locationFinder) Deprecated. Pass the custom location finder in the constructor.

Methods inherited from class org.mevenide.environment.AbstractLocationFinder

getConfigurationFileLocation

Methods inherited from class java.lang.Object

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

Constructor Detail

LocationFinderAggregator

public LocationFinderAggregator(IQueryContext queryContext)

default constructor for the aggregator

Parameters:

queryContext - the project's query context.

LocationFinderAggregator

public LocationFinderAggregator(IQueryContext queryContext,
                                ILocationFinder custom)

default constructor for the aggregator

Parameters:

queryContext - the project's query context.

Method Detail

getJavaHome

public java.lang.String getJavaHome()

Description copied from interface: ILocationFinder

The directory on the local machine that contains the JDK. Note that a JRE alone is not sufficient to execute Maven.

This is equivalent to getting the java.home system property.

Defaults to ${env.JAVA_HOME}

getMavenHome

public java.lang.String getMavenHome()

Description copied from interface: ILocationFinder

The directory on the local machine that contains Maven.

This is equivalent to getting the maven.home system property.

Defaults to ${env.MAVEN_HOME}

getMavenLocalHome

public java.lang.String getMavenLocalHome()

Description copied from interface: ILocationFinder

The directory on the local machine Maven uses to write user specific details to, such as expanded plugins and cache data.

This is equivalent to getting the maven.home.local system property.

Defaults to ${user.home}/.maven

Specified by:

getMavenLocalHome in interface ILocationFinder

Overrides:

getMavenLocalHome in class AbstractLocationFinder

getMavenLocalRepository

public java.lang.String getMavenLocalRepository()

Description copied from interface: ILocationFinder

The repository on the local machine Maven should use to store downloaded artifacts (jars etc).

This is equivalent to getting the maven.repo.local system property.

Defaults to ${maven.home.local}/repository

Specified by:

getMavenLocalRepository in interface ILocationFinder

Overrides:

getMavenLocalRepository in class AbstractLocationFinder

getMavenPluginsDir

public java.lang.String getMavenPluginsDir()

Description copied from interface: ILocationFinder

Where Maven expands installed plugins for processing.

This is equivalent to getting the maven.plugin.unpacked.dir system property.

Defaults to ${maven.home.local}/cache

Specified by:

getMavenPluginsDir in interface ILocationFinder

Overrides:

getMavenPluginsDir in class AbstractLocationFinder

getUserPluginsDir

public java.lang.String getUserPluginsDir()

Description copied from interface: ILocationFinder

Where Maven can find plugins for this user only.

This is equivalent to getting the maven.plugin.user.dir system property.

Defaults to ${maven.home.local}/plugins

Specified by:

getUserPluginsDir in interface ILocationFinder

Overrides:

getUserPluginsDir in class AbstractLocationFinder

getPluginJarsDir

public java.lang.String getPluginJarsDir()

Description copied from interface: ILocationFinder

Where Maven can find it's plugins.

This is equivalent to getting the maven.plugin.dir system property.

Defaults to ${maven.home}/plugins

Specified by:

getPluginJarsDir in interface ILocationFinder

Overrides:

getPluginJarsDir in class AbstractLocationFinder

getUserHome

public java.lang.String getUserHome()

Description copied from interface: ILocationFinder

The user's home directory on the local machine.

This is equivalent to getting the user.home system property.

Defaults to ${env.HOME}

setCustomLocationFinder

public void setCustomLocationFinder(ILocationFinder locationFinder)

Deprecated. Pass the custom location finder in the constructor.

Parameters:

customLocationFinder -