Package org.apache.maven.model
Class Notifier
java.lang.Object
org.apache.maven.model.Notifier
- All Implemented Interfaces:
Serializable
,Cloneable
,InputLocationTracker
Configures one method for notifying users/developers when a
build breaks.
- Version:
- $Revision$ $Date$
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
Deprecated.private InputLocation
Field addressLocation.private Properties
Field configuration.private InputLocation
Field configurationLocation.private InputLocation
Field location.private Map<Object,
InputLocation> Field locations.private boolean
Whether to send notifications on error.private InputLocation
Field sendOnErrorLocation.private boolean
Whether to send notifications on failure.private InputLocation
Field sendOnFailureLocation.private boolean
Whether to send notifications on success.private InputLocation
Field sendOnSuccessLocation.private boolean
Whether to send notifications on warning.private InputLocation
Field sendOnWarningLocation.private String
The mechanism used to deliver notifications.private InputLocation
Field typeLocation. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addConfiguration
(String key, String value) Method addConfiguration.clone()
Method clone.Get Deprecated.Method getConfiguration.getLocation
(Object key) Gets the location of the specified field in the input source.private InputLocation
getOtherLocation
(Object key) getType()
Get the mechanism used to deliver notifications.boolean
Get whether to send notifications on error.boolean
Get whether to send notifications on failure.boolean
Get whether to send notifications on success.boolean
Get whether to send notifications on warning.void
setAddress
(String address) Set Deprecated.void
setConfiguration
(Properties configuration) Set extended configuration specific to this notifier goes here.void
setLocation
(Object key, InputLocation location) Sets the location of the specified field.void
setOtherLocation
(Object key, InputLocation location) void
setSendOnError
(boolean sendOnError) Set whether to send notifications on error.void
setSendOnFailure
(boolean sendOnFailure) Set whether to send notifications on failure.void
setSendOnSuccess
(boolean sendOnSuccess) Set whether to send notifications on success.void
setSendOnWarning
(boolean sendOnWarning) Set whether to send notifications on warning.void
Set the mechanism used to deliver notifications.
-
Field Details
-
type
The mechanism used to deliver notifications. -
sendOnError
private boolean sendOnErrorWhether to send notifications on error. -
sendOnFailure
private boolean sendOnFailureWhether to send notifications on failure. -
sendOnSuccess
private boolean sendOnSuccessWhether to send notifications on success. -
sendOnWarning
private boolean sendOnWarningWhether to send notifications on warning. -
address
Deprecated. Where to send the notification to - eg email address. -
configuration
Field configuration. -
locations
Field locations. -
location
Field location. -
typeLocation
Field typeLocation. -
sendOnErrorLocation
Field sendOnErrorLocation. -
sendOnFailureLocation
Field sendOnFailureLocation. -
sendOnSuccessLocation
Field sendOnSuccessLocation. -
sendOnWarningLocation
Field sendOnWarningLocation. -
addressLocation
Field addressLocation. -
configurationLocation
Field configurationLocation.
-
-
Constructor Details
-
Notifier
public Notifier()
-
-
Method Details
-
addConfiguration
Method addConfiguration.- Parameters:
key
- a key object.value
- a value object.
-
clone
Method clone. -
getAddress
Get Deprecated. Where to send the notification to - eg email address.- Returns:
- String
-
getConfiguration
Method getConfiguration.- Returns:
- Properties
-
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
-
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
-
getType
Get the mechanism used to deliver notifications.- Returns:
- String
-
isSendOnError
public boolean isSendOnError()Get whether to send notifications on error.- Returns:
- boolean
-
isSendOnFailure
public boolean isSendOnFailure()Get whether to send notifications on failure.- Returns:
- boolean
-
isSendOnSuccess
public boolean isSendOnSuccess()Get whether to send notifications on success.- Returns:
- boolean
-
isSendOnWarning
public boolean isSendOnWarning()Get whether to send notifications on warning.- Returns:
- boolean
-
setAddress
Set Deprecated. Where to send the notification to - eg email address.- Parameters:
address
- a address object.
-
setConfiguration
Set extended configuration specific to this notifier goes here.- Parameters:
configuration
- a configuration object.
-
setSendOnError
public void setSendOnError(boolean sendOnError) Set whether to send notifications on error.- Parameters:
sendOnError
- a sendOnError object.
-
setSendOnFailure
public void setSendOnFailure(boolean sendOnFailure) Set whether to send notifications on failure.- Parameters:
sendOnFailure
- a sendOnFailure object.
-
setSendOnSuccess
public void setSendOnSuccess(boolean sendOnSuccess) Set whether to send notifications on success.- Parameters:
sendOnSuccess
- a sendOnSuccess object.
-
setSendOnWarning
public void setSendOnWarning(boolean sendOnWarning) Set whether to send notifications on warning.- Parameters:
sendOnWarning
- a sendOnWarning object.
-
setType
Set the mechanism used to deliver notifications.- Parameters:
type
- a type object.
-