Package org.apache.maven.model
Class Notifier
- java.lang.Object
-
- org.apache.maven.model.Notifier
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Cloneable,InputLocationTracker
public class Notifier extends java.lang.Object implements java.io.Serializable, java.lang.Cloneable, InputLocationTracker
Configures one method for notifying users/developers when a build breaks.- Version:
- $Revision$ $Date$
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.StringaddressDeprecated.private InputLocationaddressLocationField addressLocation.private java.util.PropertiesconfigurationField configuration.private InputLocationconfigurationLocationField configurationLocation.private InputLocationlocationField location.private java.util.Map<java.lang.Object,InputLocation>locationsField locations.private booleansendOnErrorWhether to send notifications on error.private InputLocationsendOnErrorLocationField sendOnErrorLocation.private booleansendOnFailureWhether to send notifications on failure.private InputLocationsendOnFailureLocationField sendOnFailureLocation.private booleansendOnSuccessWhether to send notifications on success.private InputLocationsendOnSuccessLocationField sendOnSuccessLocation.private booleansendOnWarningWhether to send notifications on warning.private InputLocationsendOnWarningLocationField sendOnWarningLocation.private java.lang.StringtypeThe mechanism used to deliver notifications.private InputLocationtypeLocationField typeLocation.
-
Constructor Summary
Constructors Constructor Description Notifier()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddConfiguration(java.lang.String key, java.lang.String value)Method addConfiguration.Notifierclone()Method clone.java.lang.StringgetAddress()Get Deprecated.java.util.PropertiesgetConfiguration()Method getConfiguration.InputLocationgetLocation(java.lang.Object key)Gets the location of the specified field in the input source.private InputLocationgetOtherLocation(java.lang.Object key)java.lang.StringgetType()Get the mechanism used to deliver notifications.booleanisSendOnError()Get whether to send notifications on error.booleanisSendOnFailure()Get whether to send notifications on failure.booleanisSendOnSuccess()Get whether to send notifications on success.booleanisSendOnWarning()Get whether to send notifications on warning.voidsetAddress(java.lang.String address)Set Deprecated.voidsetConfiguration(java.util.Properties configuration)Set extended configuration specific to this notifier goes here.voidsetLocation(java.lang.Object key, InputLocation location)Sets the location of the specified field.voidsetOtherLocation(java.lang.Object key, InputLocation location)voidsetSendOnError(boolean sendOnError)Set whether to send notifications on error.voidsetSendOnFailure(boolean sendOnFailure)Set whether to send notifications on failure.voidsetSendOnSuccess(boolean sendOnSuccess)Set whether to send notifications on success.voidsetSendOnWarning(boolean sendOnWarning)Set whether to send notifications on warning.voidsetType(java.lang.String type)Set the mechanism used to deliver notifications.
-
-
-
Field Detail
-
type
private java.lang.String type
The mechanism used to deliver notifications.
-
sendOnError
private boolean sendOnError
Whether to send notifications on error.
-
sendOnFailure
private boolean sendOnFailure
Whether to send notifications on failure.
-
sendOnSuccess
private boolean sendOnSuccess
Whether to send notifications on success.
-
sendOnWarning
private boolean sendOnWarning
Whether to send notifications on warning.
-
address
private java.lang.String address
Deprecated. Where to send the notification to - eg email address.
-
configuration
private java.util.Properties configuration
Field configuration.
-
locations
private java.util.Map<java.lang.Object,InputLocation> locations
Field locations.
-
location
private InputLocation location
Field location.
-
typeLocation
private InputLocation typeLocation
Field typeLocation.
-
sendOnErrorLocation
private InputLocation sendOnErrorLocation
Field sendOnErrorLocation.
-
sendOnFailureLocation
private InputLocation sendOnFailureLocation
Field sendOnFailureLocation.
-
sendOnSuccessLocation
private InputLocation sendOnSuccessLocation
Field sendOnSuccessLocation.
-
sendOnWarningLocation
private InputLocation sendOnWarningLocation
Field sendOnWarningLocation.
-
addressLocation
private InputLocation addressLocation
Field addressLocation.
-
configurationLocation
private InputLocation configurationLocation
Field configurationLocation.
-
-
Method Detail
-
addConfiguration
public void addConfiguration(java.lang.String key, java.lang.String value)Method addConfiguration.- Parameters:
key-value-
-
clone
public Notifier clone()
Method clone.- Overrides:
clonein classjava.lang.Object- Returns:
- Notifier
-
getAddress
public java.lang.String getAddress()
Get Deprecated. Where to send the notification to - eg email address.- Returns:
- String
-
getConfiguration
public java.util.Properties getConfiguration()
Method getConfiguration.- Returns:
- Properties
-
getLocation
public InputLocation getLocation(java.lang.Object key)
Description copied from interface:InputLocationTrackerGets the location of the specified field in the input source.- Specified by:
getLocationin interfaceInputLocationTracker- Parameters:
key-- Returns:
- InputLocation
-
setLocation
public void setLocation(java.lang.Object key, InputLocation location)Description copied from interface:InputLocationTrackerSets the location of the specified field.- Specified by:
setLocationin interfaceInputLocationTracker- Parameters:
key-location-
-
setOtherLocation
public void setOtherLocation(java.lang.Object key, InputLocation location)- Parameters:
key-location-
-
getOtherLocation
private InputLocation getOtherLocation(java.lang.Object key)
- Parameters:
key-- Returns:
- InputLocation
-
getType
public java.lang.String 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
public void setAddress(java.lang.String address)
Set Deprecated. Where to send the notification to - eg email address.- Parameters:
address-
-
setConfiguration
public void setConfiguration(java.util.Properties configuration)
Set extended configuration specific to this notifier goes here.- Parameters:
configuration-
-
setSendOnError
public void setSendOnError(boolean sendOnError)
Set whether to send notifications on error.- Parameters:
sendOnError-
-
setSendOnFailure
public void setSendOnFailure(boolean sendOnFailure)
Set whether to send notifications on failure.- Parameters:
sendOnFailure-
-
setSendOnSuccess
public void setSendOnSuccess(boolean sendOnSuccess)
Set whether to send notifications on success.- Parameters:
sendOnSuccess-
-
setSendOnWarning
public void setSendOnWarning(boolean sendOnWarning)
Set whether to send notifications on warning.- Parameters:
sendOnWarning-
-
setType
public void setType(java.lang.String type)
Set the mechanism used to deliver notifications.- Parameters:
type-
-
-