org.hypergraphdb.event
Class HGAtomRemoveRequestEvent

java.lang.Object
  extended by org.hypergraphdb.event.HGAtomEvent
      extended by org.hypergraphdb.event.HGAtomRemoveRequestEvent
All Implemented Interfaces:
HGEvent

public class HGAtomRemoveRequestEvent
extends HGAtomEvent

A HGAtomRemoveRequestEvent is triggered when an attempt is made to remove an from HyperGraph, but before the removal process proceeds. This event gives chance to an application to cancel the removal of an atom. A listener to this event may return the HGListener.Result.cancel code which will prevent the removal from happening. On the other hand, if an application needs to perform some action as a result to an already completed removal, the application should then listen to the HGAtomRemovedEvent.

Author:
Borislav Iordanov

Constructor Summary
HGAtomRemoveRequestEvent(HGHandle handle)
          Construct a new HGAtomRemoveRequestEvent for the given atom.
 
Method Summary
 
Methods inherited from class org.hypergraphdb.event.HGAtomEvent
getAtomHandle
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HGAtomRemoveRequestEvent

public HGAtomRemoveRequestEvent(HGHandle handle)

Construct a new HGAtomRemoveRequestEvent for the given atom.

Parameters:
handle - The HGHandle of the atom.