com.novell.application.console.snapin
Class InvalidateCacheEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--com.novell.application.console.snapin.InvalidateCacheEvent

All Implemented Interfaces:

java.io.Serializable

public class InvalidateCacheEvent

extends java.util.EventObject

Defines an invalidate cache event.

A shell event may consist of selection change or other such event.

See Also:

ShellSelectionListener, ShellSelectionAdapter

Field Summary

static int	DEPTH_ALL_SUBCONTAINERS A possible value for this events depth indicating that the ObjectEntry associated with this event and all of its children and their children's children, etc., should have their cache invalidated.
static int	DEPTH_ENTIRE_TREE A possible value for this events depth indicating that the entire tree should have its cache invalidated.
static int	DEPTH_IMMEDIATE_CHILDREN A possible value for this events depth indicating that the ObjectEntry associated with this event and its immediate children only should have their cache invalidated.
static int	DEPTH_SINGLE_ENTRY A possible value for this events depth indicating that only the ObjectEntry associated with this event should have its cache invalidated.

Fields inherited from class java.util.EventObject

source

Constructor Summary

InvalidateCacheEvent(ObjectEntry entry, int depth)
Creates an invalidate cache event object.

Method Summary

int	getDepth() How deep the refresh should go.
ObjectEntry	getObjectEntry() Object to refresh.

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

DEPTH_ENTIRE_TREE

public static final int DEPTH_ENTIRE_TREE

A possible value for this events depth indicating that the entire tree should have its cache invalidated. Returned from getDepth().

(DEPTH_ENTIRE_TREE = 0)

DEPTH_SINGLE_ENTRY

public static final int DEPTH_SINGLE_ENTRY

A possible value for this events depth indicating that only the ObjectEntry associated with this event should have its cache invalidated. Returned from getDepth().

(DEPTH_SINGLE_ENTRY = 0)

DEPTH_IMMEDIATE_CHILDREN

public static final int DEPTH_IMMEDIATE_CHILDREN

A possible value for this events depth indicating that the ObjectEntry associated with this event and its immediate children only should have their cache invalidated. Returned from getDepth().

(DEPTH_IMMEDIATE_CHILDREN = 0)

DEPTH_ALL_SUBCONTAINERS

public static final int DEPTH_ALL_SUBCONTAINERS

A possible value for this events depth indicating that the ObjectEntry associated with this event and all of its children and their children's children, etc., should have their cache invalidated. Returned from getDepth().

(DEPTH_ALL_SUBCONTAINERS = 0)

Constructor Detail

InvalidateCacheEvent

public InvalidateCacheEvent(ObjectEntry entry,
                            int depth)

Creates an invalidate cache event object.

Parameters:

entry - The ObjectEntry array associated with the event. If depth is DEPTH_ENTIRE_TREE, this parameter will be null.

depth - How far to refresh. This may be DEPTH_ENTIRE_TREE, DEPTH_SINGLE_ENTRY, DEPTH_IMMEDIATE_CHILDREN or DEPTH_ALL_SUBCONTAINERS.

id - An integer specifying the action that occurred on the event. Currently should only be REFRESH_ENTRY.

Method Detail

getDepth

public int getDepth()

How deep the refresh should go. Possible values are DEPTH_ENTIRE_TREE, DEPTH_SINGLE_ENTRY, DEPTH_IMMEDIATE_CHILDREN or DEPTH_ALL_SUBCONTAINERS.

Returns:

Depth to be refreshed.

getObjectEntry

public ObjectEntry getObjectEntry()

Object to refresh. If depth is DEPTH_ENTIRE_TREE, this will be null.

Returns:

ObjectEntry to refresh from.