org.openide.cookies
Interface ConnectionCookie

All Superinterfaces:

Node.Cookie

All Known Implementing Classes:

ConnectionSupport

public interface ConnectionCookie

extends Node.Cookie

Cookie that allows connection between two objects. Also supporting persistent connections.

Inner Class Summary

static class	ConnectionCookie.Event Event that is fired to listeners.
static interface	ConnectionCookie.Listener Cookie that must be provided by a node that is willing to register itself as a listener to a ConnectionCookie.
static interface	ConnectionCookie.Type Interface describing cookie type of event a cookie can produce.

Method Summary

Set	getTypes() Unmutable set of types supported by this connection source.
void	register(ConnectionCookie.Type type, Node listener) Attaches new node to listen to events produced by this event.
void	unregister(ConnectionCookie.Type type, Node listener) Unregisters an listener.

Method Detail

register

public void register(ConnectionCookie.Type type,
                     Node listener)
              throws IOException

Attaches new node to listen to events produced by this event. The type must be one of event types supported by this cookie and the listener should have ConnectionCookie.Listener cookie attached so it can be notified when event of requested type occurs.

Parameters:

type - the type of event, must be supported by the cookie

listener - the node that should be notified

Throws:

InvalidObjectException - if the type is not supported by the cookie

IOException - if the type is persistent and the listener does not have serializable handle (listener.getHandle () is null or its serialization throws an exception)

unregister

public void unregister(ConnectionCookie.Type type,
                       Node listener)
                throws IOException

Unregisters an listener.

Parameters:

type - type of event to unregister the listener from listening to

listener - to unregister

Throws:

IOException - if there is I/O operation error when the removing the listener from persistent storage

getTypes

public Set getTypes()

Unmutable set of types supported by this connection source.

Returns:

a set of Type objects