org.apache.maven.settings
Class Mirror

java.lang.Object
  extended by org.apache.maven.settings.TrackableBase
      extended by org.apache.maven.settings.IdentifiableBase
          extended by org.apache.maven.settings.Mirror
All Implemented Interfaces:
Serializable, Cloneable

public class Mirror
extends IdentifiableBase
implements Serializable, Cloneable

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
 Mirror clone()
          Method clone.
 String getLayout()
          Get the layout of the mirror repository.
 String getMirrorOf()
          Get the server ID of the repository being mirrored, eg "central".
 String getMirrorOfLayouts()
          Get the layouts of repositories being mirrored.
 String getName()
          Get the optional name that describes the mirror.
 String getUrl()
          Get the URL of the mirror repository.
 void setLayout(String layout)
          Set the layout of the mirror repository.
 void setMirrorOf(String mirrorOf)
          Set the server ID of the repository being mirrored, eg "central".
 void setMirrorOfLayouts(String mirrorOfLayouts)
          Set the layouts of repositories being mirrored.
 void setName(String name)
          Set the optional name that describes the mirror.
 void setUrl(String url)
          Set the URL of the mirror repository.
 String toString()
           
 
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
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Mirror

public Mirror()
Method Detail

clone

public Mirror clone()
Method clone.

Overrides:
clone in class IdentifiableBase
Returns:
Mirror

getLayout

public String getLayout()
Get the layout of the mirror repository. Since Maven 3.

Returns:
String

getMirrorOf

public String getMirrorOf()
Get the server ID of the repository being mirrored, eg "central". This MUST NOT match the mirror id.

Returns:
String

getMirrorOfLayouts

public String getMirrorOfLayouts()
Get the layouts of repositories being mirrored. This value can be used to restrict the usage of the mirror to repositories with a matching layout (apart from a matching id). Since Maven 3.

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

setLayout

public void setLayout(String layout)
Set the layout of the mirror repository. Since Maven 3.

Parameters:
layout -

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 -

setMirrorOfLayouts

public void setMirrorOfLayouts(String mirrorOfLayouts)
Set the layouts of repositories being mirrored. This value can be used to restrict the usage of the mirror to repositories with a matching layout (apart from a matching id). Since Maven 3.

Parameters:
mirrorOfLayouts -

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 -

toString

public String toString()
Overrides:
toString in class Object


Copyright © 2001-2010 The Apache Software Foundation. All Rights Reserved.