HiRISE

HiRISE.HiPlan.SPICE
Class KernelPoolEvent

java.lang.Object
  extended by java.util.EventObject
      extended by HiRISE.HiPlan.SPICE.KernelPoolEvent
All Implemented Interfaces:
Serializable

public class KernelPoolEvent
extends EventObject

An event that indicates the SPICE kernel pool has changed. This event is generated by a producer (such as a SPICE_Menu) when the SPICE kernel pool is updated (such as when a kernel is added to or removed from the pool). The event is passed to every KernelPoolListener object that registered to receive such events using the producer's addKernelPoolListener method.

The contents of the kernel pool at the time of the creation of an object of this class are available via the getPoolContents() method.

Version:
1.5
Author:
Christian Schaller - UA/PIRL
See Also:
Serialized Form

Field Summary
static String ID
          Class identification name with source code version and date.
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
KernelPoolEvent(Object source)
          Creates a new kernel pool event with the indicated source.
 
Method Summary
 List<String> getPoolContents()
          Gets the list of kernels in the kernel pool at the time of the event's creation.
 String toString()
          Gets a text description of this kernel pool event.
 
Methods inherited from class java.util.EventObject
getSource
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ID

public static final String ID
Class identification name with source code version and date.

See Also:
Constant Field Values
Constructor Detail

KernelPoolEvent

public KernelPoolEvent(Object source)
Creates a new kernel pool event with the indicated source. The contents of the kernel pool at the time of creation are stored as well; they are accessible via the getPoolContents() method.

Parameters:
source - the producer of the kernel pool event.
Throws:
IllegalArgumentException - if source is null.
Method Detail

getPoolContents

public final List<String> getPoolContents()
Gets the list of kernels in the kernel pool at the time of the event's creation.

Returns:
a list of kernels in the pool when the event was created.

toString

public String toString()
Gets a text description of this kernel pool event.

Overrides:
toString in class EventObject
Returns:
the text description.

HiRISE

Copyright (C) Arizona Board of Regents on behalf of the Planetary Image Research Laboratory, Lunar and Planetary Laboratory at the University of Arizona