org.apache.maven.settings
Class Settings

java.lang.Object
  org.apache.maven.settings.TrackableBase
      org.apache.maven.settings.Settings

All Implemented Interfaces:

Serializable

public class Settings

extends TrackableBase

implements Serializable

Root element of the user configuration file.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.maven.settings.TrackableBase

GLOBAL_LEVEL, USER_LEVEL

Constructor Summary

Settings()

Method Summary

void	addActiveProfile(String string) Method addActiveProfile
void	addMirror(Mirror mirror) Method addMirror
void	addPluginGroup(String string) Method addPluginGroup
void	addProfile(Profile profile) Method addProfile
void	addProxy(Proxy proxy) Method addProxy
void	addServer(Server server) Method addServer
void	flushActiveProxy()
void	flushProfileMap()
List	getActiveProfiles() Method getActiveProfiles
Proxy	getActiveProxy()
Boolean	getInteractiveMode()
String	getLocalRepository() Get The local repository.
Mirror	getMirrorOf(String repositoryId)
List	getMirrors() Method getMirrors
String	getModelEncoding()
List	getPluginGroups() Method getPluginGroups
List	getProfiles() Method getProfiles
Map	getProfilesAsMap()
List	getProxies() Method getProxies
RuntimeInfo	getRuntimeInfo()
Server	getServer(String serverId)
List	getServers() Method getServers
boolean	isInteractiveMode() Get Whether Maven should attempt to interact with the user for input.
boolean	isOffline() Get Indicate whether maven should operate in offline mode full-time.
boolean	isUsePluginRegistry() Get Whether Maven should use the plugin-registry.xml file to manage plugin versions.
void	removeActiveProfile(String string) Method removeActiveProfile
void	removeMirror(Mirror mirror) Method removeMirror
void	removePluginGroup(String string) Method removePluginGroup
void	removeProfile(Profile profile) Method removeProfile
void	removeProxy(Proxy proxy) Method removeProxy
void	removeServer(Server server) Method removeServer
void	setActiveProfiles(List activeProfiles) Set List of manually-activated build profiles, specified in the order in which they should be applied.
void	setInteractiveMode(boolean interactiveMode) Set Whether Maven should attempt to interact with the user for input.
void	setLocalRepository(String localRepository) Set The local repository.
void	setMirrors(List mirrors) Set Configuration of download mirrors for repositories.
void	setModelEncoding(String modelEncoding)
void	setOffline(boolean offline) Set Indicate whether maven should operate in offline mode full-time.
void	setPluginGroups(List pluginGroups) Set List of groupIds to search for a plugin when that plugin groupId is not explicitly provided.
void	setProfiles(List profiles) Set Configuration of build profiles for adjusting the build according to environmental parameters
void	setProxies(List proxies) Set Configuration for different proxy profiles.
void	setRuntimeInfo(RuntimeInfo runtimeInfo)
void	setServers(List servers) Set Configuration of server-specific settings, mainly authentication method.
void	setUsePluginRegistry(boolean usePluginRegistry) Set Whether Maven should use the plugin-registry.xml file to manage plugin versions.

Methods inherited from class org.apache.maven.settings.TrackableBase

getSourceLevel, setSourceLevel

Methods inherited from class java.lang.Object

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

Constructor Detail

Settings

public Settings()

Method Detail

addActiveProfile

public void addActiveProfile(String string)

Method addActiveProfile

Parameters:

string -

addMirror

public void addMirror(Mirror mirror)

Method addMirror

Parameters:

mirror -

addPluginGroup

public void addPluginGroup(String string)

Method addPluginGroup

Parameters:

string -

addProfile

public void addProfile(Profile profile)

Method addProfile

Parameters:

profile -

addProxy

public void addProxy(Proxy proxy)

Method addProxy

Parameters:

proxy -

addServer

public void addServer(Server server)

Method addServer

Parameters:

server -

getActiveProfiles

public List getActiveProfiles()

Method getActiveProfiles

getLocalRepository

public String getLocalRepository()

Get The local repository.

getMirrors

public List getMirrors()

Method getMirrors

getPluginGroups

public List getPluginGroups()

Method getPluginGroups

getProfiles

public List getProfiles()

Method getProfiles

getProxies

public List getProxies()

Method getProxies

getServers

public List getServers()

Method getServers

isInteractiveMode

public boolean isInteractiveMode()

Get Whether Maven should attempt to interact with the user for input.

isOffline

public boolean isOffline()

Get Indicate whether maven should operate in offline mode full-time.

isUsePluginRegistry

public boolean isUsePluginRegistry()

Get Whether Maven should use the plugin-registry.xml file to manage plugin versions.

removeActiveProfile

public void removeActiveProfile(String string)

Method removeActiveProfile

Parameters:

string -

removeMirror

public void removeMirror(Mirror mirror)

Method removeMirror

Parameters:

mirror -

removePluginGroup

public void removePluginGroup(String string)

Method removePluginGroup

Parameters:

string -

removeProfile

public void removeProfile(Profile profile)

Method removeProfile

Parameters:

profile -

removeProxy

public void removeProxy(Proxy proxy)

Method removeProxy

Parameters:

proxy -

removeServer

public void removeServer(Server server)

Method removeServer

Parameters:

server -

setActiveProfiles

public void setActiveProfiles(List activeProfiles)

Set List of manually-activated build profiles, specified in the order in which they should be applied.

Parameters:

activeProfiles -

setInteractiveMode

public void setInteractiveMode(boolean interactiveMode)

Set Whether Maven should attempt to interact with the user for input.

Parameters:

interactiveMode -

setLocalRepository

public void setLocalRepository(String localRepository)

Set The local repository.

Parameters:

localRepository -

setMirrors

public void setMirrors(List mirrors)

Set Configuration of download mirrors for repositories.

Parameters:

mirrors -

setOffline

public void setOffline(boolean offline)

Set Indicate whether maven should operate in offline mode full-time.

Parameters:

offline -

setPluginGroups

public void setPluginGroups(List pluginGroups)

Set List of groupIds to search for a plugin when that plugin groupId is not explicitly provided.

Parameters:

pluginGroups -

setProfiles

public void setProfiles(List profiles)

Set Configuration of build profiles for adjusting the build according to environmental parameters

Parameters:

profiles -

setProxies

public void setProxies(List proxies)

Set Configuration for different proxy profiles. Multiple proxy profiles might come in handy for anyone working from a notebook or other mobile platform, to enable easy switching of entire proxy configurations by simply specifying the profile id, again either from the command line or from the defaults section below.

Parameters:

proxies -

setServers

public void setServers(List servers)

Set Configuration of server-specific settings, mainly authentication method. This allows configuration of authentication on a per-server basis.

Parameters:

servers -

setUsePluginRegistry

public void setUsePluginRegistry(boolean usePluginRegistry)

Set Whether Maven should use the plugin-registry.xml file to manage plugin versions.

Parameters:

usePluginRegistry -

getInteractiveMode

public Boolean getInteractiveMode()

flushActiveProxy

public void flushActiveProxy()

getActiveProxy

public Proxy getActiveProxy()

getServer

public Server getServer(String serverId)

getMirrorOf

public Mirror getMirrorOf(String repositoryId)

flushProfileMap

public void flushProfileMap()

getProfilesAsMap

public Map getProfilesAsMap()

setRuntimeInfo

public void setRuntimeInfo(RuntimeInfo runtimeInfo)

getRuntimeInfo

public RuntimeInfo getRuntimeInfo()

setModelEncoding

public void setModelEncoding(String modelEncoding)

Overrides:

setModelEncoding in class TrackableBase

getModelEncoding

public String getModelEncoding()

Overrides:

getModelEncoding in class TrackableBase