public interface

IUnitNotification

com.pnfsoftware.jeb.core.units.IUnitNotification
Known Indirect Subclasses

Class Overview

Description of a unit notification. Unit notifications are generated by units to keep track of oddities, warnings, errors, malformations, corruptions, or otherwise interesting areas of a unit. Initially, they are generated during the processing of the input. However, any client code (in the general sense) can add or remove notifications to a unit.

Summary

Public Methods
abstract String getAddress()
Retrieve the optional address of this notification, if relevant.
abstract String getDescription()
Get a custom description of the notification.
abstract String getKey()
Retrieve the notification key (or name).
abstract long getTimestampMs()
Retrieve the creation timestamp of this notification.
abstract NotificationType getType()
Get the notification type.

Public Methods

public abstract String getAddress ()

Retrieve the optional address of this notification, if relevant. If the unit does support addressing (ie, the unit implements IAddressableUnit), that field may be used by clients for easy navigation to the location of interest.

Returns
  • the optional address

public abstract String getDescription ()

Get a custom description of the notification. This comes as a complement of the type, if necessary.

Returns
  • an optional description string

public abstract String getKey ()

Retrieve the notification key (or name). For a given unit, only one notification with a given key may exist; adding a notification will erase a previously existing one.

public abstract long getTimestampMs ()

Retrieve the creation timestamp of this notification.

public abstract NotificationType getType ()

Get the notification type.

Returns
  • the non-null type