AlertImpl (sakai-velocity-tool 22.0 API)

java.lang.Object
- org.sakaiproject.cheftool.AlertImpl

All Implemented Interfaces:

Serializable, org.sakaiproject.cheftool.api.Alert
```
public class AlertImpl
extends Object
implements org.sakaiproject.cheftool.api.Alert, Serializable
```
Alert is a set of messages intended for user display in the user interface.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected String m_msg
The Alert text.

Constructor Summary

Constructors
Constructor Description

AlertImpl()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`add(String alert)`	Add a new alert line.
`void`	`clear()`	Remove any messages in the Alert.
`String`	`getAlert()`	Access the alert message.
`boolean`	`isEmpty()`	Check to see if the alert is empty, or has been populated.
`String`	`peekAlert()`	Access the alert message, but unlike getAlert(), do not clear the message.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - m_msg
```
protected String m_msg
```
    The Alert text.
- Constructor Detail
  - AlertImpl
```
public AlertImpl()
```
- Method Detail
  - add
```
public void add(String alert)
```
    Add a new alert line. A line separator will be appended as needed.
    
    Specified by:
    
    add in interface org.sakaiproject.cheftool.api.Alert
    
    Parameters:
    
    alert - The alert message to add.
  - getAlert
```
public String getAlert()
```
    Access the alert message. Once accessed, the message is cleared.
    
    Specified by:
    
    getAlert in interface org.sakaiproject.cheftool.api.Alert
    
    Returns:
    
    The alert message.
  - peekAlert
```
public String peekAlert()
```
    Access the alert message, but unlike getAlert(), do not clear the message.
    
    Specified by:
    
    peekAlert in interface org.sakaiproject.cheftool.api.Alert
    
    Returns:
    
    The alert message.
  - isEmpty
```
public boolean isEmpty()
```
    Check to see if the alert is empty, or has been populated.
    
    Specified by:
    
    isEmpty in interface org.sakaiproject.cheftool.api.Alert
    
    Returns:
    
    true of the alert is empty, false if there have been alerts set.
  - clear
```
public void clear()
```
    Remove any messages in the Alert.
    
    Specified by:
    
    clear in interface org.sakaiproject.cheftool.api.Alert