Package org.apache.maven.model
Class Activation
java.lang.Object
org.apache.maven.model.Activation
- All Implemented Interfaces:
Serializable
,Cloneable
,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.
- Version:
- $Revision$ $Date$
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
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.private InputLocation
Field activeByDefaultLocation.private ActivationFile
Specifies that this profile will be activated based on existence of a file.private InputLocation
Field fileLocation.private String
Specifies that this profile will be activated when a matching JDK is detected.private InputLocation
Field jdkLocation.private InputLocation
Field location.private Map<Object,
InputLocation> Field locations.private ActivationOS
Specifies that this profile will be activated when matching operating system attributes are detected.private InputLocation
Field osLocation.private ActivationProperty
Specifies that this profile will be activated when this property is specified.private InputLocation
Field propertyLocation. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Method clone.getFile()
Get specifies that this profile will be activated based on existence of a file.getJdk()
Get specifies that this profile will be activated when a matching JDK is detected.getLocation
(Object key) Gets the location of the specified field in the input source.getOs()
Get specifies that this profile will be activated when matching operating system attributes are detected.private InputLocation
getOtherLocation
(Object key) Get specifies that this profile will be activated when this property is specified.boolean
Get 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.void
setActiveByDefault
(boolean activeByDefault) Set 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.void
setFile
(ActivationFile file) Set specifies that this profile will be activated based on existence of a file.void
Set specifies that this profile will be activated when a matching JDK is detected.void
setLocation
(Object key, InputLocation location) Sets the location of the specified field.void
setOs
(ActivationOS os) Set specifies that this profile will be activated when matching operating system attributes are detected.void
setOtherLocation
(Object key, InputLocation location) void
setProperty
(ActivationProperty property) Set specifies that this profile will be activated when this property is specified.
-
Field Details
-
activeByDefault
private boolean activeByDefaultIf 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. -
jdk
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. -
os
Specifies that this profile will be activated when matching operating system attributes are detected. -
property
Specifies that this profile will be activated when this property is specified. -
file
Specifies that this profile will be activated based on existence of a file. -
locations
Field locations. -
location
Field location. -
activeByDefaultLocation
Field activeByDefaultLocation. -
jdkLocation
Field jdkLocation. -
osLocation
Field osLocation. -
propertyLocation
Field propertyLocation. -
fileLocation
Field fileLocation.
-
-
Constructor Details
-
Activation
public Activation()
-
-
Method Details
-
clone
Method clone. -
getFile
Get specifies that this profile will be activated based on existence of a file.- Returns:
- ActivationFile
-
getJdk
Get 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:
- String
-
getLocation
Description copied from interface:InputLocationTracker
Gets the location of the specified field in the input source.- Specified by:
getLocation
in interfaceInputLocationTracker
- Parameters:
key
- a key object.- Returns:
- InputLocation
-
getOs
Get specifies that this profile will be activated when matching operating system attributes are detected.- Returns:
- ActivationOS
-
setLocation
Description copied from interface:InputLocationTracker
Sets the location of the specified field.- Specified by:
setLocation
in interfaceInputLocationTracker
- Parameters:
key
- a key object.location
- a location object.
-
setOtherLocation
- Parameters:
key
- a key object.location
- a location object.
-
getOtherLocation
- Parameters:
key
- a key object.- Returns:
- InputLocation
-
getProperty
Get specifies that this profile will be activated when this property is specified.- Returns:
- ActivationProperty
-
isActiveByDefault
public boolean isActiveByDefault()Get 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:
- boolean
-
setActiveByDefault
public void setActiveByDefault(boolean activeByDefault) Set 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.- Parameters:
activeByDefault
- a activeByDefault object.
-
setFile
Set specifies that this profile will be activated based on existence of a file.- Parameters:
file
- a file object.
-
setJdk
Set 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.- Parameters:
jdk
- a jdk object.
-
setOs
Set specifies that this profile will be activated when matching operating system attributes are detected.- Parameters:
os
- a os object.
-
setProperty
Set specifies that this profile will be activated when this property is specified.- Parameters:
property
- a property object.
-