org.apache.maven.api.model

Class Activation

java.lang.Object

org.apache.maven.api.model.Activation

All Implemented Interfaces:

Serializable, InputLocationTracker

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

The conditions within the build runtime environment which will trigger the automatic inclusion of the build profile. Multiple conditions can be defined, which must be all satisfied to activate the profile.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
ActivationFile	getFile() Specifies that this profile will be activated based on existence of a file.
String	getJdk() Specifies that this profile will be activated when a matching JDK is detected.
InputLocation	getLocation(Object key) Gets the location of the specified field in the input source.
ActivationOS	getOs() Specifies that this profile will be activated when matching operating system attributes are detected.
ActivationProperty	getProperty() Specifies that this profile will be activated when this system property is specified.
boolean	isActiveByDefault() If set to true, this profile will be active unless another profile in this pom is activated using the command line -P option or by one of that profile's activators.
static Activation.Builder	newBuilder() Creates a new Activation builder instance.
static Activation.Builder	newBuilder(Activation from) Creates a new Activation builder instance using the specified object as a basis.
static Activation.Builder	newBuilder(Activation from, boolean forceCopy) Creates a new Activation builder instance using the specified object as a basis.
static Activation.Builder	newBuilder(boolean withDefaults) Creates a new Activation builder instance using default values or not.
static Activation	newInstance() Creates a new Activation instance.
static Activation	newInstance(boolean withDefaults) Creates a new Activation instance using default values or not.
Activation.Builder	with() Creates a new builder with this object as the basis.
Activation	withActiveByDefault(boolean activeByDefault) Creates a new Activation instance using the specified activeByDefault.
Activation	withFile(ActivationFile file) Creates a new Activation instance using the specified file.
Activation	withJdk(String jdk) Creates a new Activation instance using the specified jdk.
Activation	withOs(ActivationOS os) Creates a new Activation instance using the specified os.
Activation	withProperty(ActivationProperty property) Creates a new Activation instance using the specified property.

Methods inherited from class java.lang.Object

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

Method Detail

isActiveByDefault

public boolean isActiveByDefault()

If set to true, this profile will be active unless another profile in this pom is activated using the command line -P option or by one of that profile's activators.

Returns:

a boolean

getJdk

public String getJdk()

Specifies that this profile will be activated when a matching JDK is detected. For example, 1.4 only activates on JDKs versioned 1.4, while !1.4 matches any JDK that is not version 1.4. Ranges are supported too: [1.5,) activates when the JDK is 1.5 minimum.

Returns:

a String

getOs

public ActivationOS getOs()

Specifies that this profile will be activated when matching operating system attributes are detected.

Returns:

a ActivationOS

getProperty

public ActivationProperty getProperty()

Specifies that this profile will be activated when this system property is specified.

Returns:

a ActivationProperty

getFile

public ActivationFile getFile()

Specifies that this profile will be activated based on existence of a file.

Returns:

a ActivationFile

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

Creates a new builder with this object as the basis.

Returns:

a Builder

withActiveByDefault

@Nonnull
public Activation withActiveByDefault(boolean activeByDefault)

Creates a new Activation instance using the specified activeByDefault.

Parameters:

activeByDefault - the new boolean to use

Returns:

a Activation with the specified activeByDefault

withJdk

@Nonnull
public Activation withJdk(String jdk)

Creates a new Activation instance using the specified jdk.

Parameters:

jdk - the new String to use

Returns:

a Activation with the specified jdk

withOs

@Nonnull
public Activation withOs(ActivationOS os)

Creates a new Activation instance using the specified os.

Parameters:

os - the new ActivationOS to use

Returns:

a Activation with the specified os

withProperty

@Nonnull
public Activation withProperty(ActivationProperty property)

Creates a new Activation instance using the specified property.

Parameters:

property - the new ActivationProperty to use

Returns:

a Activation with the specified property

withFile

@Nonnull
public Activation withFile(ActivationFile file)

Creates a new Activation instance using the specified file.

Parameters:

file - the new ActivationFile to use

Returns:

a Activation with the specified file

newInstance

@Nonnull
public static Activation newInstance()

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

Returns:

a new Activation

See Also:

newInstance(boolean)

newInstance

@Nonnull
public static Activation newInstance(boolean withDefaults)

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

newBuilder

@Nonnull
public static Activation.Builder newBuilder()

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

Returns:

a new Builder

See Also:

newBuilder(boolean)

newBuilder

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

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

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

Parameters:

from - the Activation instance to use as a basis

Returns:

a new Builder

newBuilder

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

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

Parameters:

from - the Activation instance to use as a basis

forceCopy - the boolean indicating if a copy should be forced

Returns:

a new Builder