org.apache.maven.settings
Class Settings

java.lang.Object
  extended by org.apache.maven.settings.TrackableBase
      extended by org.apache.maven.settings.Settings
All Implemented Interfaces:
java.io.Serializable

public class Settings
extends TrackableBase
implements java.io.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(java.lang.String string)
          Method addActiveProfile
 void addMirror(Mirror mirror)
          Method addMirror
 void addPluginGroup(java.lang.String string)
          Method addPluginGroup
 void addProfile(Profile profile)
          Method addProfile
 void addProxy(Proxy proxy)
          Method addProxy
 void addServer(Server server)
          Method addServer
 void flushActiveProxy()
          Reset the activeProxy field to null
 void flushProfileMap()
          Reset the profileMap field to null
 java.util.List getActiveProfiles()
          Method getActiveProfiles
 Proxy getActiveProxy()
           
 java.lang.Boolean getInteractiveMode()
           
 java.lang.String getLocalRepository()
          Get The local repository.
 Mirror getMirrorOf(java.lang.String repositoryId)
           
 java.util.List getMirrors()
          Method getMirrors
 java.lang.String getModelEncoding()
           
 java.util.List getPluginGroups()
          Method getPluginGroups
 java.util.List getProfiles()
          Method getProfiles
 java.util.Map getProfilesAsMap()
           
 java.util.List getProxies()
          Method getProxies
 RuntimeInfo getRuntimeInfo()
           
 Server getServer(java.lang.String serverId)
           
 java.util.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(java.lang.String string)
          Method removeActiveProfile
 void removeMirror(Mirror mirror)
          Method removeMirror
 void removePluginGroup(java.lang.String string)
          Method removePluginGroup
 void removeProfile(Profile profile)
          Method removeProfile
 void removeProxy(Proxy proxy)
          Method removeProxy
 void removeServer(Server server)
          Method removeServer
 void setActiveProfiles(java.util.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(java.lang.String localRepository)
          Set The local repository.
 void setMirrors(java.util.List mirrors)
          Set Configuration of download mirrors for repositories.
 void setModelEncoding(java.lang.String modelEncoding)
           
 void setOffline(boolean offline)
          Set Indicate whether maven should operate in offline mode full-time.
 void setPluginGroups(java.util.List pluginGroups)
          Set List of groupIds to search for a plugin when that plugin groupId is not explicitly provided.
 void setProfiles(java.util.List profiles)
          Set Configuration of build profiles for adjusting the build according to environmental parameters.
 void setProxies(java.util.List proxies)
          Set Configuration for different proxy profiles.
 void setRuntimeInfo(RuntimeInfo runtimeInfo)
           
 void setServers(java.util.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(java.lang.String string)
Method addActiveProfile

Parameters:
string -

addMirror

public void addMirror(Mirror mirror)
Method addMirror

Parameters:
mirror -

addPluginGroup

public void addPluginGroup(java.lang.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 java.util.List getActiveProfiles()
Method getActiveProfiles


getLocalRepository

public java.lang.String getLocalRepository()
Get The local repository.


getMirrors

public java.util.List getMirrors()
Method getMirrors


getPluginGroups

public java.util.List getPluginGroups()
Method getPluginGroups


getProfiles

public java.util.List getProfiles()
Method getProfiles


getProxies

public java.util.List getProxies()
Method getProxies


getServers

public java.util.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(java.lang.String string)
Method removeActiveProfile

Parameters:
string -

removeMirror

public void removeMirror(Mirror mirror)
Method removeMirror

Parameters:
mirror -

removePluginGroup

public void removePluginGroup(java.lang.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(java.util.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(java.lang.String localRepository)
Set The local repository.

Parameters:
localRepository -

setMirrors

public void setMirrors(java.util.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(java.util.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(java.util.List profiles)
Set Configuration of build profiles for adjusting the build according to environmental parameters.

Parameters:
profiles -

setProxies

public void setProxies(java.util.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(java.util.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 java.lang.Boolean getInteractiveMode()

flushActiveProxy

public void flushActiveProxy()
Reset the activeProxy field to null


getActiveProxy

public Proxy getActiveProxy()
Returns:
the first active proxy

getServer

public Server getServer(java.lang.String serverId)

getMirrorOf

public Mirror getMirrorOf(java.lang.String repositoryId)

flushProfileMap

public void flushProfileMap()
Reset the profileMap field to null


getProfilesAsMap

public java.util.Map getProfilesAsMap()
Returns:
a Map of profiles field with Profile#getId() as key
See Also:
IdentifiableBase.getId()

setRuntimeInfo

public void setRuntimeInfo(RuntimeInfo runtimeInfo)

getRuntimeInfo

public RuntimeInfo getRuntimeInfo()

setModelEncoding

public void setModelEncoding(java.lang.String modelEncoding)
Overrides:
setModelEncoding in class TrackableBase

getModelEncoding

public java.lang.String getModelEncoding()
Overrides:
getModelEncoding in class TrackableBase


Copyright © 2001-2011 Apache Software Foundation. All Rights Reserved.