UpdateEvent (dataset 11.1.5 API)

java.lang.Object
- java.util.EventObject
- - de.gsi.dataset.event.UpdateEvent

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AxisChangeEvent, InvalidatedEvent, UpdatedDataEvent, UpdatedMetaDataEvent
```
public class UpdateEvent
extends java.util.EventObject
```
Event class that is passed along the notification performed by the EventSource class. The class is intended to be further extended by named derivatives to allow for context-based event filters.

Author:

rstein

See Also:

for details, Serialized Form

Field Summary
- Fields inherited from class java.util.EventObject
  source

Constructor Summary

Constructors
Constructor	Description
`UpdateEvent(EventSource source)`	generates new update event
`UpdateEvent(EventSource source, java.lang.String msg)`	generates new update event
`UpdateEvent(EventSource source, java.lang.String msg, java.lang.Object payload)`	generates new update event

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

java.lang.String getMessage()

java.lang.Object getPayLoad()
- Methods inherited from class java.util.EventObject
  getSource, toString
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UpdateEvent
```
public UpdateEvent(EventSource source)
```
    generates new update event
    
    Parameters:
    
    source - the class issuing the event
  - UpdateEvent
```
public UpdateEvent(EventSource source,
                   java.lang.String msg)
```
    generates new update event
    
    Parameters:
    
    source - the class issuing the event
    
    msg - a customised message to be passed along (e.g. for debugging)
  - UpdateEvent
```
public UpdateEvent(EventSource source,
                   java.lang.String msg,
                   java.lang.Object payload)
```
    generates new update event
    
    Parameters:
    
    source - the class issuing the event
    
    msg - a customised message to be passed along (e.g. for debugging)
    
    payload - a customised user pay-load to be passed to the listener
- Method Detail
  - getMessage
```
public java.lang.String getMessage()
```
    Returns:
    
    a customised message to be passed along (e.g. for debugging)
  - getPayLoad
```
public java.lang.Object getPayLoad()
```
    Returns:
    
    a customised user pay-load to be passed to the listener