org.apache.maven.api.settings

Class Profile

java.lang.Object

org.apache.maven.api.settings.TrackableBase

org.apache.maven.api.settings.IdentifiableBase

org.apache.maven.api.settings.Profile

All Implemented Interfaces:

Serializable

@Experimental
 @Generated
 @ThreadSafe
 @Immutable
public class Profile
extends IdentifiableBase
implements Serializable

Modifications to the build process which is keyed on some sort of environmental parameter.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class org.apache.maven.api.settings.TrackableBase

GLOBAL_LEVEL, USER_LEVEL

Method Summary

Modifier and Type	Method and Description
Activation	getActivation() The conditional logic which will automatically trigger the inclusion of this profile.
List<Repository>	getPluginRepositories() The lists of the remote repositories for discovering plugins.
Map<String,String>	getProperties() Extended configuration specific to this profile goes here.
List<Repository>	getRepositories() The lists of the remote repositories.
static Profile.Builder	newBuilder() Creates a new Profile builder instance.
static Profile.Builder	newBuilder(boolean withDefaults) Creates a new Profile builder instance using default values or not.
static Profile.Builder	newBuilder(Profile from) Creates a new Profile builder instance using the specified object as a basis.
static Profile.Builder	newBuilder(Profile from, boolean forceCopy) Creates a new Profile builder instance using the specified object as a basis.
static Profile	newInstance() Creates a new Profile instance.
static Profile	newInstance(boolean withDefaults) Creates a new Profile instance using default values or not.
Profile.Builder	with() Creates a new builder with this object as the basis.
Profile	withActivation(Activation activation) Creates a new Profile instance using the specified activation.
Profile	withId(String id) Creates a new Profile instance using the specified id.
Profile	withPluginRepositories(Collection<Repository> pluginRepositories) Creates a new Profile instance using the specified pluginRepositories.
Profile	withProperties(Map<String,String> properties) Creates a new Profile instance using the specified properties.
Profile	withRepositories(Collection<Repository> repositories) Creates a new Profile instance using the specified repositories.

Methods inherited from class org.apache.maven.api.settings.IdentifiableBase

getId, newBuilder, newBuilder

Methods inherited from class org.apache.maven.api.settings.TrackableBase

getSourceLevel, newBuilder, newBuilder, setSourceLevel

Methods inherited from class java.lang.Object

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

Method Detail

getActivation

public Activation getActivation()

The conditional logic which will automatically trigger the inclusion of this profile.

Returns:

a Activation

getProperties

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

Extended configuration specific to this profile goes here. Contents take the form of <property.name>property.value</property.name>

Returns:

a Map<String, String>

getRepositories

@Nonnull
public List<Repository> getRepositories()

The lists of the remote repositories.

Returns:

a List<Repository>

getPluginRepositories

@Nonnull
public List<Repository> getPluginRepositories()

The lists of the remote repositories for discovering plugins.

Returns:

a List<Repository>

with

@Nonnull
public Profile.Builder with()

Creates a new builder with this object as the basis.

Overrides:

with in class IdentifiableBase

Returns:

a Builder

withId

@Nonnull
public Profile withId(String id)

Creates a new Profile instance using the specified id.

Overrides:

withId in class IdentifiableBase

Parameters:

id - the new String to use

Returns:

a Profile with the specified id

withActivation

@Nonnull
public Profile withActivation(Activation activation)

Creates a new Profile instance using the specified activation.

Parameters:

activation - the new Activation to use

Returns:

a Profile with the specified activation

withProperties

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

Creates a new Profile instance using the specified properties.

Parameters:

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

Returns:

a Profile with the specified properties

withRepositories

@Nonnull
public Profile withRepositories(Collection<Repository> repositories)

Creates a new Profile instance using the specified repositories.

Parameters:

repositories - the new Collection<Repository> to use

Returns:

a Profile with the specified repositories

withPluginRepositories

@Nonnull
public Profile withPluginRepositories(Collection<Repository> pluginRepositories)

Creates a new Profile instance using the specified pluginRepositories.

Parameters:

pluginRepositories - the new Collection<Repository> to use

Returns:

a Profile with the specified pluginRepositories

newInstance

@Nonnull
public static Profile newInstance()

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

Returns:

a new Profile

See Also:

newInstance(boolean)

newInstance

@Nonnull
public static Profile newInstance(boolean withDefaults)

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

newBuilder

@Nonnull
public static Profile.Builder newBuilder()

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

Returns:

a new Builder

See Also:

newBuilder(boolean)

newBuilder

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

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

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

Parameters:

from - the Profile instance to use as a basis

Returns:

a new Builder

newBuilder

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

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

Parameters:

from - the Profile instance to use as a basis

forceCopy - the boolean indicating if a copy should be forced

Returns:

a new Builder