org.apache.maven.model
Class Site

java.lang.Object
  extended by org.apache.maven.model.Site
All Implemented Interfaces:
Serializable, Cloneable, InputLocationTracker

public class Site
extends Object
implements Serializable, Cloneable, InputLocationTracker

Contains the information needed for deploying websites.

Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary
Site()
           
 
Method Summary
 Site clone()
          Method clone.
 String getId()
          Get a unique identifier for a deployment location.
 InputLocation getLocation(Object key)
          Gets the location of the specified field in the input source.
 String getName()
          Get human readable name of the deployment location.
 String getUrl()
          Get the url of the location where website is deployed, in the form protocol://hostname/path.
 void setId(String id)
          Set a unique identifier for a deployment location.
 void setLocation(Object key, InputLocation location)
          Sets the location of the specified field.
 void setName(String name)
          Set human readable name of the deployment location.
 void setUrl(String url)
          Set the url of the location where website is deployed, in the form protocol://hostname/path.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Site

public Site()
Method Detail

clone

public Site clone()
Method clone.

Overrides:
clone in class Object
Returns:
Site

getId

public String getId()
Get a unique identifier for a deployment location. This is used to match the site to configuration in the settings.xml file, for example.

Returns:
String

getLocation

public InputLocation getLocation(Object key)
Description copied from interface: InputLocationTracker
Gets the location of the specified field in the input source.

Specified by:
getLocation in interface InputLocationTracker
Parameters:
key -
Returns:
InputLocation

getName

public String getName()
Get human readable name of the deployment location.

Returns:
String

getUrl

public String getUrl()
Get the url of the location where website is deployed, in the form protocol://hostname/path.

Returns:
String

setId

public void setId(String id)
Set a unique identifier for a deployment location. This is used to match the site to configuration in the settings.xml file, for example.

Parameters:
id -

setLocation

public void setLocation(Object key,
                        InputLocation location)
Description copied from interface: InputLocationTracker
Sets the location of the specified field.

Specified by:
setLocation in interface InputLocationTracker
Parameters:
key -
location -

setName

public void setName(String name)
Set human readable name of the deployment location.

Parameters:
name -

setUrl

public void setUrl(String url)
Set the url of the location where website is deployed, in the form protocol://hostname/path.

Parameters:
url -


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