org.apache.maven.api.model

Class MailingList

java.lang.Object

org.apache.maven.api.model.MailingList

All Implemented Interfaces:

Serializable, InputLocationTracker

@Experimental
 @Generated
 @ThreadSafe
 @Immutable
public class MailingList
extends Object
implements Serializable, InputLocationTracker

This element describes all of the mailing lists associated with a project. The auto-generated site references this information.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
String	getArchive() The link to a URL where you can browse the mailing list archive.
InputLocation	getLocation(Object key) Gets the location of the specified field in the input source.
String	getName() The name of the mailing list.
List<String>	getOtherArchives() The link to alternate URLs where you can browse the list archive.
String	getPost() The email address or link that can be used to post to the mailing list.
String	getSubscribe() The email address or link that can be used to subscribe to the mailing list.
String	getUnsubscribe() The email address or link that can be used to unsubscribe to the mailing list.
static MailingList.Builder	newBuilder() Creates a new MailingList builder instance.
static MailingList.Builder	newBuilder(boolean withDefaults) Creates a new MailingList builder instance using default values or not.
static MailingList.Builder	newBuilder(MailingList from) Creates a new MailingList builder instance using the specified object as a basis.
static MailingList.Builder	newBuilder(MailingList from, boolean forceCopy) Creates a new MailingList builder instance using the specified object as a basis.
static MailingList	newInstance() Creates a new MailingList instance.
static MailingList	newInstance(boolean withDefaults) Creates a new MailingList instance using default values or not.
MailingList.Builder	with() Creates a new builder with this object as the basis.
MailingList	withArchive(String archive) Creates a new MailingList instance using the specified archive.
MailingList	withName(String name) Creates a new MailingList instance using the specified name.
MailingList	withOtherArchives(Collection<String> otherArchives) Creates a new MailingList instance using the specified otherArchives.
MailingList	withPost(String post) Creates a new MailingList instance using the specified post.
MailingList	withSubscribe(String subscribe) Creates a new MailingList instance using the specified subscribe.
MailingList	withUnsubscribe(String unsubscribe) Creates a new MailingList instance using the specified unsubscribe.

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 name of the mailing list.

Returns:

a String

getSubscribe

public String getSubscribe()

The email address or link that can be used to subscribe to the mailing list. If this is an email address, a mailto: link will automatically be created when the documentation is created.

Returns:

a String

getUnsubscribe

public String getUnsubscribe()

The email address or link that can be used to unsubscribe to the mailing list. If this is an email address, a mailto: link will automatically be created when the documentation is created.

Returns:

a String

getPost

public String getPost()

The email address or link that can be used to post to the mailing list. If this is an email address, a mailto: link will automatically be created when the documentation is created.

Returns:

a String

getArchive

public String getArchive()

The link to a URL where you can browse the mailing list archive.

Returns:

a String

getOtherArchives

@Nonnull
public List<String> getOtherArchives()

The link to alternate URLs where you can browse the list archive.

Returns:

a List<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 MailingList.Builder with()

Creates a new builder with this object as the basis.

Returns:

a Builder

withName

@Nonnull
public MailingList withName(String name)

Creates a new MailingList instance using the specified name.

Parameters:

name - the new String to use

Returns:

a MailingList with the specified name

withSubscribe

@Nonnull
public MailingList withSubscribe(String subscribe)

Creates a new MailingList instance using the specified subscribe.

Parameters:

subscribe - the new String to use

Returns:

a MailingList with the specified subscribe

withUnsubscribe

@Nonnull
public MailingList withUnsubscribe(String unsubscribe)

Creates a new MailingList instance using the specified unsubscribe.

Parameters:

unsubscribe - the new String to use

Returns:

a MailingList with the specified unsubscribe

withPost

@Nonnull
public MailingList withPost(String post)

Creates a new MailingList instance using the specified post.

Parameters:

post - the new String to use

Returns:

a MailingList with the specified post

withArchive

@Nonnull
public MailingList withArchive(String archive)

Creates a new MailingList instance using the specified archive.

Parameters:

archive - the new String to use

Returns:

a MailingList with the specified archive

withOtherArchives

@Nonnull
public MailingList withOtherArchives(Collection<String> otherArchives)

Creates a new MailingList instance using the specified otherArchives.

Parameters:

otherArchives - the new Collection<String> to use

Returns:

a MailingList with the specified otherArchives

newInstance

@Nonnull
public static MailingList newInstance()

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

Returns:

a new MailingList

See Also:

newInstance(boolean)

newInstance

@Nonnull
public static MailingList newInstance(boolean withDefaults)

Creates a new MailingList 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 MailingList

newBuilder

@Nonnull
public static MailingList.Builder newBuilder()

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

Returns:

a new Builder

See Also:

newBuilder(boolean)

newBuilder

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

Creates a new MailingList 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 MailingList.Builder newBuilder(MailingList from)

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

Parameters:

from - the MailingList instance to use as a basis

Returns:

a new Builder

newBuilder

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

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

Parameters:

from - the MailingList instance to use as a basis

forceCopy - the boolean indicating if a copy should be forced

Returns:

a new Builder