org.apache.maven.api.model

Class CiManagement

java.lang.Object

org.apache.maven.api.model.CiManagement

All Implemented Interfaces:

Serializable, InputLocationTracker

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

The <ciManagement> element contains informations required to the continuous integration system of the project.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
InputLocation	getLocation(Object key) Gets the location of the specified field in the input source.
List<Notifier>	getNotifiers() Configuration for notifying developers/users when a build is unsuccessful, including user information and notification mode.
String	getSystem() The name of the continuous integration system, e.g.
String	getUrl() URL for the continuous integration system used by the project if it has a web interface.
static CiManagement.Builder	newBuilder() Creates a new CiManagement builder instance.
static CiManagement.Builder	newBuilder(boolean withDefaults) Creates a new CiManagement builder instance using default values or not.
static CiManagement.Builder	newBuilder(CiManagement from) Creates a new CiManagement builder instance using the specified object as a basis.
static CiManagement.Builder	newBuilder(CiManagement from, boolean forceCopy) Creates a new CiManagement builder instance using the specified object as a basis.
static CiManagement	newInstance() Creates a new CiManagement instance.
static CiManagement	newInstance(boolean withDefaults) Creates a new CiManagement instance using default values or not.
CiManagement.Builder	with() Creates a new builder with this object as the basis.
CiManagement	withNotifiers(Collection<Notifier> notifiers) Creates a new CiManagement instance using the specified notifiers.
CiManagement	withSystem(String system) Creates a new CiManagement instance using the specified system.
CiManagement	withUrl(String url) Creates a new CiManagement 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

getSystem

public String getSystem()

The name of the continuous integration system, e.g. continuum.

Returns:

a String

getUrl

public String getUrl()

URL for the continuous integration system used by the project if it has a web interface.

Returns:

a String

getNotifiers

@Nonnull
public List<Notifier> getNotifiers()

Configuration for notifying developers/users when a build is unsuccessful, including user information and notification mode.

Returns:

a List<Notifier>

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 CiManagement.Builder with()

Creates a new builder with this object as the basis.

Returns:

a Builder

withSystem

@Nonnull
public CiManagement withSystem(String system)

Creates a new CiManagement instance using the specified system.

Parameters:

system - the new String to use

Returns:

a CiManagement with the specified system

withUrl

@Nonnull
public CiManagement withUrl(String url)

Creates a new CiManagement instance using the specified url.

Parameters:

url - the new String to use

Returns:

a CiManagement with the specified url

withNotifiers

@Nonnull
public CiManagement withNotifiers(Collection<Notifier> notifiers)

Creates a new CiManagement instance using the specified notifiers.

Parameters:

notifiers - the new Collection<Notifier> to use

Returns:

a CiManagement with the specified notifiers

newInstance

@Nonnull
public static CiManagement newInstance()

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

Returns:

a new CiManagement

See Also:

newInstance(boolean)

newInstance

@Nonnull
public static CiManagement newInstance(boolean withDefaults)

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

newBuilder

@Nonnull
public static CiManagement.Builder newBuilder()

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

Returns:

a new Builder

See Also:

newBuilder(boolean)

newBuilder

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

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

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

Parameters:

from - the CiManagement instance to use as a basis

Returns:

a new Builder

newBuilder

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

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

Parameters:

from - the CiManagement instance to use as a basis

forceCopy - the boolean indicating if a copy should be forced

Returns:

a new Builder