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.String
address
Deprecated.private InputLocation
addressLocation
Field addressLocation.private java.util.Properties
configuration
Field configuration.private InputLocation
configurationLocation
Field configurationLocation.private InputLocation
location
Field location.private java.util.Map<java.lang.Object,InputLocation>
locations
Field locations.private boolean
sendOnError
Whether to send notifications on error.private InputLocation
sendOnErrorLocation
Field sendOnErrorLocation.private boolean
sendOnFailure
Whether to send notifications on failure.private InputLocation
sendOnFailureLocation
Field sendOnFailureLocation.private boolean
sendOnSuccess
Whether to send notifications on success.private InputLocation
sendOnSuccessLocation
Field sendOnSuccessLocation.private boolean
sendOnWarning
Whether to send notifications on warning.private InputLocation
sendOnWarningLocation
Field sendOnWarningLocation.private java.lang.String
type
The mechanism used to deliver notifications.private InputLocation
typeLocation
Field typeLocation.
-
Constructor Summary
Constructors Constructor Description Notifier()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addConfiguration(java.lang.String key, java.lang.String value)
Method addConfiguration.Notifier
clone()
Method clone.java.lang.String
getAddress()
Get Deprecated.java.util.Properties
getConfiguration()
Method getConfiguration.InputLocation
getLocation(java.lang.Object key)
Gets the location of the specified field in the input source.private InputLocation
getOtherLocation(java.lang.Object key)
java.lang.String
getType()
Get the mechanism used to deliver notifications.boolean
isSendOnError()
Get whether to send notifications on error.boolean
isSendOnFailure()
Get whether to send notifications on failure.boolean
isSendOnSuccess()
Get whether to send notifications on success.boolean
isSendOnWarning()
Get whether to send notifications on warning.void
setAddress(java.lang.String address)
Set Deprecated.void
setConfiguration(java.util.Properties configuration)
Set extended configuration specific to this notifier goes here.void
setLocation(java.lang.Object key, InputLocation location)
Sets the location of the specified field.void
setOtherLocation(java.lang.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
setType(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
- a key object.value
- a value object.
-
clone
public Notifier clone()
Method clone.- Overrides:
clone
in 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: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
public void setLocation(java.lang.Object key, InputLocation location)
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
public void setOtherLocation(java.lang.Object key, InputLocation location)
- Parameters:
key
- a key object.location
- a location object.
-
getOtherLocation
private InputLocation getOtherLocation(java.lang.Object key)
- Parameters:
key
- a key object.- 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
- a address object.
-
setConfiguration
public void setConfiguration(java.util.Properties configuration)
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
public void setType(java.lang.String type)
Set the mechanism used to deliver notifications.- Parameters:
type
- a type object.
-
-