org.apache.maven.settings
Class Mirror

java.lang.Object
  org.apache.maven.settings.TrackableBase
      org.apache.maven.settings.IdentifiableBase
          org.apache.maven.settings.Mirror

All Implemented Interfaces:

Serializable

public class Mirror
extends IdentifiableBase
implements Serializable

A download mirror for a given repository.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Field Summary

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

GLOBAL_LEVEL, USER_LEVEL

Constructor Summary

Mirror()

Method Summary

String	getMirrorOf() Get The server ID of the repository being mirrored, eg "central".
String	getModelEncoding()
String	getName() Get The optional name that describes the mirror.
String	getUrl() Get the URL of the mirror repository.
void	setMirrorOf(String mirrorOf) Set The server ID of the repository being mirrored, eg "central".
void	setModelEncoding(String modelEncoding) Set an encoding used for reading/writing the model.
void	setName(String name) Set The optional name that describes the mirror.
void	setUrl(String url) Set the URL of the mirror repository.

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

getId, setId

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

Mirror

public Mirror()

Method Detail

getMirrorOf

public String getMirrorOf()

Get The server ID of the repository being mirrored, eg "central". This MUST NOT match the mirror id.

Returns:

String

getName

public String getName()

Get The optional name that describes the mirror.

Returns:

String

getUrl

public String getUrl()

Get the URL of the mirror repository.

Returns:

String

setMirrorOf

public void setMirrorOf(String mirrorOf)

Set The server ID of the repository being mirrored, eg "central". This MUST NOT match the mirror id.

Parameters:

mirrorOf -

setName

public void setName(String name)

Set The optional name that describes the mirror.

Parameters:

name -

setUrl

public void setUrl(String url)

Set the URL of the mirror repository.

Parameters:

url -

setModelEncoding

public void setModelEncoding(String modelEncoding)

Set an encoding used for reading/writing the model.

Overrides:

setModelEncoding in class IdentifiableBase

Parameters:

modelEncoding - the encoding used when reading/writing the model.

getModelEncoding

public String getModelEncoding()

Overrides:

getModelEncoding in class IdentifiableBase

Returns:

the current encoding used when reading/writing this model.