org.apache.maven.settings.Settings Maven / Gradle / Ivy
// =================== DO NOT EDIT THIS FILE ====================
// Generated by Modello 2.1.2,
// any modifications will be overwritten.
// ==============================================================
package org.apache.maven.settings;
/**
*
* Root element of the user configuration file.
*
*
* @version $Revision$ $Date$
*/
@SuppressWarnings( "all" )
public class Settings
extends TrackableBase
implements java.io.Serializable, java.lang.Cloneable
{
//--------------------------/
//- Class/Member Variables -/
//--------------------------/
/**
*
*
* The local repository.
Default value
* is: ${user.home}/.m2/repository
*
*
*/
private String localRepository;
/**
*
*
* Whether Maven should attempt to interact with
* the user for input.
*
*
*/
private boolean interactiveMode = true;
/**
*
*
* Whether Maven should use the plugin-registry.xml
* file to manage plugin versions.
*
*
*/
private boolean usePluginRegistry = false;
/**
*
*
* Indicate whether maven should operate in offline
* mode full-time.
*
*
*/
private boolean offline = false;
/**
* Field proxies.
*/
private java.util.List proxies;
/**
* Field servers.
*/
private java.util.List servers;
/**
* Field mirrors.
*/
private java.util.List mirrors;
/**
* Field profiles.
*/
private java.util.List profiles;
/**
* Field activeProfiles.
*/
private java.util.List activeProfiles;
/**
* Field pluginGroups.
*/
private java.util.List pluginGroups;
/**
* Field modelEncoding.
*/
private String modelEncoding = "UTF-8";
//-----------/
//- Methods -/
//-----------/
/**
* Method addActiveProfile.
*
* @param string a string object.
*/
public void addActiveProfile( String string )
{
getActiveProfiles().add( string );
} //-- void addActiveProfile( String )
/**
* Method addMirror.
*
* @param mirror a mirror object.
*/
public void addMirror( Mirror mirror )
{
getMirrors().add( mirror );
} //-- void addMirror( Mirror )
/**
* Method addPluginGroup.
*
* @param string a string object.
*/
public void addPluginGroup( String string )
{
getPluginGroups().add( string );
} //-- void addPluginGroup( String )
/**
* Method addProfile.
*
* @param profile a profile object.
*/
public void addProfile( Profile profile )
{
getProfiles().add( profile );
} //-- void addProfile( Profile )
/**
* Method addProxy.
*
* @param proxy a proxy object.
*/
public void addProxy( Proxy proxy )
{
getProxies().add( proxy );
} //-- void addProxy( Proxy )
/**
* Method addServer.
*
* @param server a server object.
*/
public void addServer( Server server )
{
getServers().add( server );
} //-- void addServer( Server )
/**
* Method clone.
*
* @return Settings
*/
public Settings clone()
{
try
{
Settings copy = (Settings) super.clone();
if ( this.proxies != null )
{
copy.proxies = new java.util.ArrayList();
for ( Proxy item : this.proxies )
{
copy.proxies.add( ( (Proxy) item).clone() );
}
}
if ( this.servers != null )
{
copy.servers = new java.util.ArrayList();
for ( Server item : this.servers )
{
copy.servers.add( ( (Server) item).clone() );
}
}
if ( this.mirrors != null )
{
copy.mirrors = new java.util.ArrayList();
for ( Mirror item : this.mirrors )
{
copy.mirrors.add( ( (Mirror) item).clone() );
}
}
if ( this.profiles != null )
{
copy.profiles = new java.util.ArrayList();
for ( Profile item : this.profiles )
{
copy.profiles.add( ( (Profile) item).clone() );
}
}
if ( this.activeProfiles != null )
{
copy.activeProfiles = new java.util.ArrayList();
copy.activeProfiles.addAll( this.activeProfiles );
}
if ( this.pluginGroups != null )
{
copy.pluginGroups = new java.util.ArrayList();
copy.pluginGroups.addAll( this.pluginGroups );
}
return copy;
}
catch ( java.lang.Exception ex )
{
throw (java.lang.RuntimeException) new java.lang.UnsupportedOperationException( getClass().getName()
+ " does not support clone()" ).initCause( ex );
}
} //-- Settings clone()
/**
* Method getActiveProfiles.
*
* @return List
*/
public java.util.List getActiveProfiles()
{
if ( this.activeProfiles == null )
{
this.activeProfiles = new java.util.ArrayList();
}
return this.activeProfiles;
} //-- java.util.List getActiveProfiles()
/**
* Get the local repository.
Default value is:
* ${user.home}/.m2/repository
*
* @return String
*/
public String getLocalRepository()
{
return this.localRepository;
} //-- String getLocalRepository()
/**
* Method getMirrors.
*
* @return List
*/
public java.util.List getMirrors()
{
if ( this.mirrors == null )
{
this.mirrors = new java.util.ArrayList();
}
return this.mirrors;
} //-- java.util.List getMirrors()
/**
* Get the modelEncoding field.
*
* @return String
*/
public String getModelEncoding()
{
return this.modelEncoding;
} //-- String getModelEncoding()
/**
* Method getPluginGroups.
*
* @return List
*/
public java.util.List getPluginGroups()
{
if ( this.pluginGroups == null )
{
this.pluginGroups = new java.util.ArrayList();
}
return this.pluginGroups;
} //-- java.util.List getPluginGroups()
/**
* Method getProfiles.
*
* @return List
*/
public java.util.List getProfiles()
{
if ( this.profiles == null )
{
this.profiles = new java.util.ArrayList();
}
return this.profiles;
} //-- java.util.List getProfiles()
/**
* Method getProxies.
*
* @return List
*/
public java.util.List getProxies()
{
if ( this.proxies == null )
{
this.proxies = new java.util.ArrayList();
}
return this.proxies;
} //-- java.util.List getProxies()
/**
* Method getServers.
*
* @return List
*/
public java.util.List getServers()
{
if ( this.servers == null )
{
this.servers = new java.util.ArrayList();
}
return this.servers;
} //-- java.util.List getServers()
/**
* Get whether Maven should attempt to interact with the user
* for input.
*
* @return boolean
*/
public boolean isInteractiveMode()
{
return this.interactiveMode;
} //-- boolean isInteractiveMode()
/**
* Get indicate whether maven should operate in offline mode
* full-time.
*
* @return boolean
*/
public boolean isOffline()
{
return this.offline;
} //-- boolean isOffline()
/**
* Get whether Maven should use the plugin-registry.xml file to
* manage plugin versions.
*
* @return boolean
*/
public boolean isUsePluginRegistry()
{
return this.usePluginRegistry;
} //-- boolean isUsePluginRegistry()
/**
* Method removeActiveProfile.
*
* @param string a string object.
*/
public void removeActiveProfile( String string )
{
getActiveProfiles().remove( string );
} //-- void removeActiveProfile( String )
/**
* Method removeMirror.
*
* @param mirror a mirror object.
*/
public void removeMirror( Mirror mirror )
{
getMirrors().remove( mirror );
} //-- void removeMirror( Mirror )
/**
* Method removePluginGroup.
*
* @param string a string object.
*/
public void removePluginGroup( String string )
{
getPluginGroups().remove( string );
} //-- void removePluginGroup( String )
/**
* Method removeProfile.
*
* @param profile a profile object.
*/
public void removeProfile( Profile profile )
{
getProfiles().remove( profile );
} //-- void removeProfile( Profile )
/**
* Method removeProxy.
*
* @param proxy a proxy object.
*/
public void removeProxy( Proxy proxy )
{
getProxies().remove( proxy );
} //-- void removeProxy( Proxy )
/**
* Method removeServer.
*
* @param server a server object.
*/
public void removeServer( Server server )
{
getServers().remove( server );
} //-- void removeServer( Server )
/**
* Set list of manually-activated build profiles, specified in
* the order in which
* they should be applied.
*
* @param activeProfiles a activeProfiles object.
*/
public void setActiveProfiles( java.util.List activeProfiles )
{
this.activeProfiles = activeProfiles;
} //-- void setActiveProfiles( java.util.List )
/**
* Set whether Maven should attempt to interact with the user
* for input.
*
* @param interactiveMode a interactiveMode object.
*/
public void setInteractiveMode( boolean interactiveMode )
{
this.interactiveMode = interactiveMode;
} //-- void setInteractiveMode( boolean )
/**
* Set the local repository.
Default value is:
* ${user.home}/.m2/repository
*
* @param localRepository a localRepository object.
*/
public void setLocalRepository( String localRepository )
{
this.localRepository = localRepository;
} //-- void setLocalRepository( String )
/**
* Set configuration of download mirrors for repositories.
*
* @param mirrors a mirrors object.
*/
public void setMirrors( java.util.List mirrors )
{
this.mirrors = mirrors;
} //-- void setMirrors( java.util.List )
/**
* Set the modelEncoding field.
*
* @param modelEncoding a modelEncoding object.
*/
public void setModelEncoding( String modelEncoding )
{
this.modelEncoding = modelEncoding;
} //-- void setModelEncoding( String )
/**
* Set indicate whether maven should operate in offline mode
* full-time.
*
* @param offline a offline object.
*/
public void setOffline( boolean offline )
{
this.offline = offline;
} //-- void setOffline( boolean )
/**
* Set list of groupIds to search for a plugin when that plugin
* groupId is not explicitly provided.
*
* @param pluginGroups a pluginGroups object.
*/
public void setPluginGroups( java.util.List pluginGroups )
{
this.pluginGroups = pluginGroups;
} //-- void setPluginGroups( java.util.List )
/**
* Set configuration of build profiles for adjusting the build
* according to environmental parameters.
*
* @param profiles a profiles object.
*/
public void setProfiles( java.util.List profiles )
{
this.profiles = profiles;
} //-- void setProfiles( java.util.List )
/**
* 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.
*
* @param proxies a proxies object.
*/
public void setProxies( java.util.List proxies )
{
this.proxies = proxies;
} //-- void setProxies( java.util.List )
/**
* Set configuration of server-specific settings, mainly
* authentication
* method. This allows configuration of
* authentication on a per-server
* basis.
*
* @param servers a servers object.
*/
public void setServers( java.util.List servers )
{
this.servers = servers;
} //-- void setServers( java.util.List )
/**
* Set whether Maven should use the plugin-registry.xml file to
* manage plugin versions.
*
* @param usePluginRegistry a usePluginRegistry object.
*/
public void setUsePluginRegistry( boolean usePluginRegistry )
{
this.usePluginRegistry = usePluginRegistry;
} //-- void setUsePluginRegistry( boolean )
public Boolean getInteractiveMode()
{
return Boolean.valueOf( isInteractiveMode() );
}
private Proxy activeProxy;
/**
* Reset the activeProxy field to null
*/
public void flushActiveProxy()
{
this.activeProxy = null;
}
/**
* @return the first active proxy
*/
public synchronized Proxy getActiveProxy()
{
if ( activeProxy == null )
{
java.util.List proxies = getProxies();
if ( proxies != null && !proxies.isEmpty() )
{
for ( Proxy proxy : proxies )
{
if ( proxy.isActive() )
{
activeProxy = proxy;
break;
}
}
}
}
return activeProxy;
}
public Server getServer( String serverId )
{
Server match = null;
java.util.List servers = getServers();
if ( servers != null && serverId != null )
{
for ( Server server : servers )
{
if ( serverId.equals( server.getId() ) )
{
match = server;
break;
}
}
}
return match;
}
@Deprecated
public Mirror getMirrorOf( String repositoryId )
{
Mirror match = null;
java.util.List mirrors = getMirrors();
if ( mirrors != null && repositoryId != null )
{
for ( Mirror mirror : mirrors )
{
if ( repositoryId.equals( mirror.getMirrorOf() ) )
{
match = mirror;
break;
}
}
}
return match;
}
private java.util.Map profileMap;
/**
* Reset the profileMap field to null
*/
public void flushProfileMap()
{
this.profileMap = null;
}
/**
* @return a Map of profiles field with Profile#getId() as key
* @see org.apache.maven.settings.Profile#getId()
*/
public java.util.Map getProfilesAsMap()
{
if ( profileMap == null )
{
profileMap = new java.util.LinkedHashMap();
if ( getProfiles() != null )
{
for ( Profile profile : getProfiles() )
{
profileMap.put( profile.getId(), profile );
}
}
}
return profileMap;
}
}