JobListCompleteEvent (adams-pom 24.12.0-SNAPSHOT API)

java.lang.Object
- java.util.EventObject
- - adams.event.JobListCompleteEvent

All Implemented Interfaces:

Serializable
```
public class JobListCompleteEvent
extends EventObject
```
Event object that gets sent after all jobs in a queue have finished.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

JobList, Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected Object m_Payload
a payload object (can be arbitrary object).
- Fields inherited from class java.util.EventObject
  source

Constructor Summary

Constructors
Constructor	Description
`JobListCompleteEvent(Object source)`	Initializes the event.
`JobListCompleteEvent(Object source, Object payload)`	Initializes the event with an additional payload object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Object`	`getPayload()`	Returns the payload object, if any.
`JobList`	`getQueue()`	Returns the queue that finished all its jobs.
`boolean`	`hasPayload()`	Checks whether there was any payload object provided.

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

- Field Detail
  - m_Payload
```
protected Object m_Payload
```
    a payload object (can be arbitrary object).
- Constructor Detail
  - JobListCompleteEvent
```
public JobListCompleteEvent(Object source)
```
    Initializes the event.
    
    Parameters:
    
    source - the object that triggered the event
  - JobListCompleteEvent
```
public JobListCompleteEvent(Object source,
                            Object payload)
```
    Initializes the event with an additional payload object.
    
    Parameters:
    
    source - the object that triggered the event
    
    payload - an additional object
- Method Detail
  - getQueue
```
public JobList getQueue()
```
    Returns the queue that finished all its jobs.
    
    Returns:
    
    the queue
  - hasPayload
```
public boolean hasPayload()
```
    Checks whether there was any payload object provided.
    
    Returns:
    
    true if a payload object resides in this event
    
    See Also:
    
    getPayload()
  - getPayload
```
public Object getPayload()
```
    Returns the payload object, if any.
    
    Returns:
    
    the payload object, can be null
    
    See Also:
    
    hasPayload()