org.apache.maven.model

Class Contributor

java.lang.Object

org.apache.maven.model.Contributor

All Implemented Interfaces:

Serializable, Cloneable, InputLocationTracker

Direct Known Subclasses:

Developer

public class Contributor
extends Object
implements Serializable, Cloneable, InputLocationTracker

Description of a person who has contributed to the project, but who does not have commit privileges. Usually, these contributions come in the form of patches submitted.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Contributor()

Method Summary

Modifier and Type	Method and Description
void	addProperty(String key, String value) Method addProperty.
void	addRole(String string) Method addRole.
Contributor	clone() Method clone.
String	getEmail() Get the email address of the contributor.
InputLocation	getLocation(Object key) Gets the location of the specified field in the input source.
String	getName() Get the full name of the contributor.
String	getOrganization() Get the organization to which the contributor belongs.
String	getOrganizationUrl() Get the URL of the organization.
Properties	getProperties() Method getProperties.
List<String>	getRoles() Method getRoles.
String	getTimezone() Get the timezone the contributor is in.
String	getUrl() Get the URL for the homepage of the contributor.
void	removeRole(String string) Method removeRole.
void	setEmail(String email) Set the email address of the contributor.
void	setLocation(Object key, InputLocation location) Sets the location of the specified field.
void	setName(String name) Set the full name of the contributor.
void	setOrganization(String organization) Set the organization to which the contributor belongs.
void	setOrganizationUrl(String organizationUrl) Set the URL of the organization.
void	setOtherLocation(Object key, InputLocation location)
void	setProperties(Properties properties) Set properties about the contributor, such as an instant messenger handle.
void	setRoles(List<String> roles) Set the roles the contributor plays in the project.
void	setTimezone(String timezone) Set the timezone the contributor is in.
void	setUrl(String url) Set the URL for the homepage of the contributor.
String	toString()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Contributor

public Contributor()

Method Detail

addProperty

public void addProperty(String key,
                        String value)

Method addProperty.

Parameters:

key -

value -

addRole

public void addRole(String string)

Method addRole.

Parameters:

string -

clone

public Contributor clone()

Method clone.

Overrides:

clone in class Object

Returns:

Contributor

getEmail

public String getEmail()

Get the email address of the contributor.

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 the full name of the contributor.

Returns:

String

getOrganization

public String getOrganization()

Get the organization to which the contributor belongs.

Returns:

String

getOrganizationUrl

public String getOrganizationUrl()

Get the URL of the organization.

Returns:

String

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 -

setOtherLocation

public void setOtherLocation(Object key,
                             InputLocation location)

Parameters:

key -

location -

getProperties

public Properties getProperties()

Method getProperties.

Returns:

Properties

getRoles

public List<String> getRoles()

Method getRoles.

Returns:

List

getTimezone

public String getTimezone()

Get the timezone the contributor is in. Typically, this is a number in the range -12 to +14 or a valid time zone id like "America/Montreal" (UTC-05:00) or "Europe/Paris" (UTC+01:00).

Returns:

String

getUrl

public String getUrl()

Get the URL for the homepage of the contributor.

Returns:

String

removeRole

public void removeRole(String string)

Method removeRole.

Parameters:

string -

setEmail

public void setEmail(String email)

Set the email address of the contributor.

Parameters:

email -

setName

public void setName(String name)

Set the full name of the contributor.

Parameters:

name -

setOrganization

public void setOrganization(String organization)

Set the organization to which the contributor belongs.

Parameters:

organization -

setOrganizationUrl

public void setOrganizationUrl(String organizationUrl)

Set the URL of the organization.

Parameters:

organizationUrl -

setProperties

public void setProperties(Properties properties)

Set properties about the contributor, such as an instant messenger handle.

Parameters:

properties -

setRoles

public void setRoles(List<String> roles)

Set the roles the contributor plays in the project. Each role is described by a role element, the body of which is a role name. This can also be used to describe the contribution.

Parameters:

roles -

setTimezone

public void setTimezone(String timezone)

Set the timezone the contributor is in. Typically, this is a number in the range -12 to +14 or a valid time zone id like "America/Montreal" (UTC-05:00) or "Europe/Paris" (UTC+01:00).

Parameters:

timezone -

setUrl

public void setUrl(String url)

Set the URL for the homepage of the contributor.

Parameters:

url -

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()