org.apache.maven.api.model

Class Contributor

java.lang.Object

org.apache.maven.api.model.Contributor

All Implemented Interfaces:

Serializable, InputLocationTracker

Direct Known Subclasses:

Developer

@Experimental
 @Generated
 @ThreadSafe
 @Immutable
public class Contributor
extends Object
implements Serializable, 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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Contributor.Builder Builder class used to create Contributor instances.

Method Summary

Modifier and Type	Method and Description
String	getEmail() The email address of the contributor.
InputLocation	getLocation(Object key) Gets the location of the specified field in the input source.
String	getName() The full name of the contributor.
String	getOrganization() The organization to which the contributor belongs.
String	getOrganizationUrl() The URL of the organization.
Map<String,String>	getProperties() Properties about the contributor, such as an instant messenger handle.
List<String>	getRoles() The roles the contributor plays in the project.
String	getTimezone() The timezone the contributor is in.
String	getUrl() The URL for the homepage of the contributor.
static Contributor.Builder	newBuilder() Creates a new Contributor builder instance.
static Contributor.Builder	newBuilder(boolean withDefaults) Creates a new Contributor builder instance using default values or not.
static Contributor.Builder	newBuilder(Contributor from) Creates a new Contributor builder instance using the specified object as a basis.
static Contributor.Builder	newBuilder(Contributor from, boolean forceCopy) Creates a new Contributor builder instance using the specified object as a basis.
static Contributor	newInstance() Creates a new Contributor instance.
static Contributor	newInstance(boolean withDefaults) Creates a new Contributor instance using default values or not.
Contributor.Builder	with() Creates a new builder with this object as the basis.
Contributor	withEmail(String email) Creates a new Contributor instance using the specified email.
Contributor	withName(String name) Creates a new Contributor instance using the specified name.
Contributor	withOrganization(String organization) Creates a new Contributor instance using the specified organization.
Contributor	withOrganizationUrl(String organizationUrl) Creates a new Contributor instance using the specified organizationUrl.
Contributor	withProperties(Map<String,String> properties) Creates a new Contributor instance using the specified properties.
Contributor	withRoles(Collection<String> roles) Creates a new Contributor instance using the specified roles.
Contributor	withTimezone(String timezone) Creates a new Contributor instance using the specified timezone.
Contributor	withUrl(String url) Creates a new Contributor instance using the specified url.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

The full name of the contributor.

Returns:

a String

getEmail

public String getEmail()

The email address of the contributor.

Returns:

a String

getUrl

public String getUrl()

The URL for the homepage of the contributor.

Returns:

a String

getOrganization

public String getOrganization()

The organization to which the contributor belongs.

Returns:

a String

getOrganizationUrl

public String getOrganizationUrl()

The URL of the organization.

Returns:

a String

getRoles

@Nonnull
public List<String> getRoles()

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.

Returns:

a List<String>

getTimezone

public String getTimezone()

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:

a String

getProperties

@Nonnull
public Map<String,String> getProperties()

Properties about the contributor, such as an instant messenger handle.

Returns:

a Map<String, String>

getLocation

public InputLocation getLocation(Object key)

Gets the location of the specified field in the input source.

Specified by:

getLocation in interface InputLocationTracker

with

@Nonnull
public Contributor.Builder with()

Creates a new builder with this object as the basis.

Returns:

a Builder

withName

@Nonnull
public Contributor withName(String name)

Creates a new Contributor instance using the specified name.

Parameters:

name - the new String to use

Returns:

a Contributor with the specified name

withEmail

@Nonnull
public Contributor withEmail(String email)

Creates a new Contributor instance using the specified email.

Parameters:

email - the new String to use

Returns:

a Contributor with the specified email

withUrl

@Nonnull
public Contributor withUrl(String url)

Creates a new Contributor instance using the specified url.

Parameters:

url - the new String to use

Returns:

a Contributor with the specified url

withOrganization

@Nonnull
public Contributor withOrganization(String organization)

Creates a new Contributor instance using the specified organization.

Parameters:

organization - the new String to use

Returns:

a Contributor with the specified organization

withOrganizationUrl

@Nonnull
public Contributor withOrganizationUrl(String organizationUrl)

Creates a new Contributor instance using the specified organizationUrl.

Parameters:

organizationUrl - the new String to use

Returns:

a Contributor with the specified organizationUrl

withRoles

@Nonnull
public Contributor withRoles(Collection<String> roles)

Creates a new Contributor instance using the specified roles.

Parameters:

roles - the new Collection<String> to use

Returns:

a Contributor with the specified roles

withTimezone

@Nonnull
public Contributor withTimezone(String timezone)

Creates a new Contributor instance using the specified timezone.

Parameters:

timezone - the new String to use

Returns:

a Contributor with the specified timezone

withProperties

@Nonnull
public Contributor withProperties(Map<String,String> properties)

Creates a new Contributor instance using the specified properties.

Parameters:

properties - the new Map<String, String> to use

Returns:

a Contributor with the specified properties

newInstance

@Nonnull
public static Contributor newInstance()

Creates a new Contributor instance. Equivalent to newInstance( true ).

Returns:

a new Contributor

See Also:

newInstance(boolean)

newInstance

@Nonnull
public static Contributor newInstance(boolean withDefaults)

Creates a new Contributor instance using default values or not. Equivalent to newBuilder( withDefaults ).build().

Parameters:

withDefaults - the boolean indicating whether default values should be used

Returns:

a new Contributor

newBuilder

@Nonnull
public static Contributor.Builder newBuilder()

Creates a new Contributor builder instance. Equivalent to newBuilder( true ).

Returns:

a new Builder

See Also:

newBuilder(boolean)

newBuilder

@Nonnull
public static Contributor.Builder newBuilder(boolean withDefaults)

Creates a new Contributor builder instance using default values or not.

Parameters:

withDefaults - the boolean indicating whether default values should be used

Returns:

a new Builder

newBuilder

@Nonnull
public static Contributor.Builder newBuilder(Contributor from)

Creates a new Contributor builder instance using the specified object as a basis. Equivalent to newBuilder( from, false ).

Parameters:

from - the Contributor instance to use as a basis

Returns:

a new Builder

newBuilder

@Nonnull
public static Contributor.Builder newBuilder(Contributor from,
                                                      boolean forceCopy)

Creates a new Contributor builder instance using the specified object as a basis.

Parameters:

from - the Contributor instance to use as a basis

forceCopy - the boolean indicating if a copy should be forced

Returns:

a new Builder