icy.common

Interface CollapsibleEvent

All Known Implementing Classes:

Anchor2D.Anchor2DEvent, Anchor3D.Anchor3DEvent, CanvasLayerEvent, IcyBufferedImageEvent, IcyCanvasEvent, IcyColorMapEvent, IcyColorModelEvent, IcyColorSpaceEvent, LUTEvent, OverlayEvent, PainterEvent, ROIEvent, ScalerEvent, SequenceEvent

public interface CollapsibleEvent

Collapsible interface for collapsible event used by UpdateEventHandler.
As we use HashMap to store these events, so we rely on Object.equals(..) and Object.hashcode() implementation for these events.

Author:

Stephane

Method Summary

Methods

Modifier and Type	Method and Description
boolean	collapse(CollapsibleEvent event) Collapse current object/event with specified one.
boolean	equals(java.lang.Object event) Returns true if the current event is equivalent to the specified one.
int	hashCode() Returns hash code for current event.

Method Detail

collapse

boolean collapse(CollapsibleEvent event)

Collapse current object/event with specified one.

Returns:

false if collapse operation failed (object are not 'equals')

equals

boolean equals(java.lang.Object event)

Returns true if the current event is equivalent to the specified one.
We want event to override Object.equals(Object) method as we use an HashMap to store these event in the UpdateEventHandler class.

Overrides:

equals in class java.lang.Object

hashCode

int hashCode()

Returns hash code for current event. It should respect the default Object.hashCode() contract.

Overrides:

hashCode in class java.lang.Object