Package org.apache.maven.model

Class Notifier

java.lang.Object

org.apache.maven.model.Notifier

All Implemented Interfaces:

Serializable, Cloneable, InputLocationTracker

public class Notifier
extends Object
implements Serializable, Cloneable, InputLocationTracker

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

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Notifier()

Method Summary

Modifier and Type	Method	Description
void	addConfiguration(String key, String value)	Method addConfiguration.
Notifier	clone()	Method clone.
String	getAddress()	Get Deprecated.
Properties	getConfiguration()	Method getConfiguration.
InputLocation	getLocation(Object key)	Gets the location of the specified field in the input source.
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(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	setType(String type)	Set the mechanism used to deliver notifications.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Notifier

public Notifier()

Method Detail

addConfiguration

public void addConfiguration(String key,
                             String value)

Method addConfiguration.

Parameters:

key - a key object.

value - a value object.

clone

public Notifier clone()

Method clone.

Overrides:

clone in class Object

Returns:

Notifier

getAddress

public String getAddress()

Get Deprecated. Where to send the notification to - eg email address.

Returns:

String

getConfiguration

public Properties getConfiguration()

Method getConfiguration.

Returns:

Properties

getLocation

public InputLocation getLocation(Object key)

Description copied from interface: InputLocationTracker

Gets the location of the specified field in the input source.

Specified by:

getLocation in interface InputLocationTracker

Parameters:

key - a key object.

Returns:

InputLocation

setLocation

public void setLocation(Object key,
                        InputLocation location)

Description copied from interface: InputLocationTracker

Sets the location of the specified field.

Specified by:

setLocation in interface InputLocationTracker

Parameters:

key - a key object.

location - a location object.

setOtherLocation

public void setOtherLocation(Object key,
                             InputLocation location)

Parameters:

key - a key object.

location - a location object.

getType

public 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(String address)

Set Deprecated. Where to send the notification to - eg email address.

Parameters:

address - a address object.

setConfiguration

public void setConfiguration(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(String type)

Set the mechanism used to deliver notifications.

Parameters:

type - a type object.