org.apache.maven.model
Class Notifier

java.lang.Object
  extended by org.apache.maven.model.Notifier
All Implemented Interfaces:
java.io.Serializable

public class Notifier
extends java.lang.Object
implements java.io.Serializable

Configures one method for notifying users/developers when a build breaks.

Version:
$Revision$ $Date$
See Also:
Serialized Form

Field Summary
private  java.lang.String address
          Deprecated.
private  java.util.Properties configuration
          Field configuration.
private  boolean sendOnError
          Whether to send notifications on error.
private  boolean sendOnFailure
          Whether to send notifications on failure.
private  boolean sendOnSuccess
          Whether to send notifications on success.
private  boolean sendOnWarning
          Whether to send notifications on warning.
private  java.lang.String type
          The mechanism used to deliver notifications.
 
Constructor Summary
Notifier()
           
 
Method Summary
 void addConfiguration(java.lang.String key, java.lang.String value)
          Method addConfiguration.
 java.lang.String getAddress()
          Get Deprecated.
 java.util.Properties getConfiguration()
          Method getConfiguration.
 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 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

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.

Constructor Detail

Notifier

public Notifier()
Method Detail

addConfiguration

public void addConfiguration(java.lang.String key,
                             java.lang.String value)
Method addConfiguration.

Parameters:
key -
value -

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

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 -