| java.lang.Object | |
| ↳ | com.pnfsoftware.jeb.core.units.UnitNotification |
Class Overview
Standard implementation of a notification.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
UnitNotification(NotificationType type, String description, String address)
Create a notification.
| |||||||||||
|
UnitNotification(NotificationType type, String description)
Create an address-less notification.
| |||||||||||
| Protected Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| UnitNotification() | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| String |
getAddress()
Retrieve the optional address of this notification, if relevant.
| ||||||||||
| String |
getDescription()
Get a custom description of the notification.
| ||||||||||
| NotificationType |
getType()
Get the notification type.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
|
From interface
com.pnfsoftware.jeb.core.units.IUnitNotification
| |||||||||||
Public Constructors
public UnitNotification (NotificationType type, String description, String address)
Create a notification.
Parameters
| type | the mandatory type |
|---|---|
| description | optional description string |
| address | optional address, useful for interactive units
|
public UnitNotification (NotificationType type, String description)
Create an address-less notification.
Parameters
| type | mandatory type |
|---|---|
| description | optional description string |
Protected Constructors
protected UnitNotification ()
Public Methods
public String getAddress ()
Retrieve the optional address of this notification, if relevant. If the unit does support
addressing (ie, the unit implements IInteractiveUnit), that field may be used by
clients for easy navigation to the location of interest.
Returns
- the optional address
public String getDescription ()
Get a custom description of the notification. This comes as a complement of the type, if necessary.
Returns
- an optional description string