org.mevenide.environment
Interface ILocationFinder

All Known Subinterfaces:

IMutableLocationFinder

All Known Implementing Classes:

AbstractLocationFinder, CustomLocationFinder, LocationFinderAggregator, MissingLocationFinder, SysEnvLocationFinder

public interface ILocationFinder

Finder for important maven locations.

Version:

$Id: ILocationFinder.java,v 1.1 15 nov. 2003 Exp gdodinet

Author:

Gilles Dodinet (gdodinet@wanadoo.fr)

Field Summary

static java.lang.String	FOREHEAD_CONF_FILE
static java.lang.String	JAVA_HOME
static java.lang.String	MAVEN_HOME
static java.lang.String	MAVEN_HOME_LOCAL
static java.lang.String	MAVEN_PLUGIN_DIR
static java.lang.String	MAVEN_PLUGIN_UNPACKED_DIR
static java.lang.String	MAVEN_PLUGIN_USER_DIR
static java.lang.String	MAVEN_REPO_LOCAL
static java.lang.String	USER_HOME

Method Summary

java.lang.String	getConfigurationFileLocation() Where Maven can find it's forehead configuration file.
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.

Field Detail

FOREHEAD_CONF_FILE

static final java.lang.String FOREHEAD_CONF_FILE

See Also:

Constant Field Values

JAVA_HOME

static final java.lang.String JAVA_HOME

See Also:

Constant Field Values

MAVEN_HOME

static final java.lang.String MAVEN_HOME

See Also:

Constant Field Values

MAVEN_HOME_LOCAL

static final java.lang.String MAVEN_HOME_LOCAL

See Also:

Constant Field Values

MAVEN_PLUGIN_DIR

static final java.lang.String MAVEN_PLUGIN_DIR

See Also:

Constant Field Values

MAVEN_PLUGIN_UNPACKED_DIR

static final java.lang.String MAVEN_PLUGIN_UNPACKED_DIR

See Also:

Constant Field Values

MAVEN_PLUGIN_USER_DIR

static final java.lang.String MAVEN_PLUGIN_USER_DIR

See Also:

Constant Field Values

MAVEN_REPO_LOCAL

static final java.lang.String MAVEN_REPO_LOCAL

See Also:

Constant Field Values

USER_HOME

static final java.lang.String USER_HOME

See Also:

Constant Field Values

Method Detail

getMavenHome

java.lang.String getMavenHome()

The directory on the local machine that contains Maven.

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

Defaults to ${env.MAVEN_HOME}

getJavaHome

java.lang.String getJavaHome()

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}

getMavenLocalHome

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.

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

Defaults to ${user.home}/.maven

getMavenLocalRepository

java.lang.String getMavenLocalRepository()

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

getMavenPluginsDir

java.lang.String getMavenPluginsDir()

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

getUserPluginsDir

java.lang.String getUserPluginsDir()

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

getPluginJarsDir

java.lang.String getPluginJarsDir()

Where Maven can find it's plugins.

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

Defaults to ${maven.home}/plugins

getConfigurationFileLocation

java.lang.String getConfigurationFileLocation()

Where Maven can find it's forehead configuration file.

This is equivalent to getting the forehead.conf.file system property.

Defaults to ${maven.home}/bin/forehead.conf

getUserHome

java.lang.String getUserHome()

The user's home directory on the local machine.

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

Defaults to ${env.HOME}