org.eclipse.emf.ecp.internal.core.util

Class Registry<ELEMENT,OBSERVER extends ECPObserver>

java.lang.Object

org.eclipse.net4j.util.event.Notifier

org.eclipse.net4j.util.lifecycle.Lifecycle

org.eclipse.emf.ecp.internal.core.util.Registry<ELEMENT,OBSERVER>

Type Parameters:

ELEMENT -

OBSERVER -

All Implemented Interfaces:

ECPDisposable.DisposeListener, org.eclipse.net4j.util.event.INotifier, org.eclipse.net4j.util.lifecycle.IDeactivateable, org.eclipse.net4j.util.lifecycle.ILifecycle, org.eclipse.net4j.util.lifecycle.ILifecycle.DeferrableActivation

Direct Known Subclasses:

ElementRegistry, Properties

public abstract class Registry<ELEMENT,OBSERVER extends ECPObserver>
extends org.eclipse.net4j.util.lifecycle.Lifecycle
implements ECPDisposable.DisposeListener

Author:

Eike Stepper

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.net4j.util.lifecycle.ILifecycle

org.eclipse.net4j.util.lifecycle.ILifecycle.DeferrableActivation

Field Summary

Fields inherited from class org.eclipse.net4j.util.lifecycle.Lifecycle

USE_LABEL

Constructor Summary

Constructors

Constructor and Description
Registry() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	addObserver(OBSERVER observer) Adds an ECPObserver to the ECPObserverBus.
void	changeElements(Set<String> remove, Set<ELEMENT> add) Adds or remove elements contained in the registry.
void	disposed(ECPDisposable disposable) Callback method being used to notify listeners about a dispose.
protected Set<ELEMENT>	doChangeElements(Set<String> remove, Set<ELEMENT> add) Executes adding or removing elements contained in the registry.
protected void	elementsChanged(Collection<ELEMENT> oldElements, Collection<ELEMENT> newElements)
ELEMENT	getElement(String key) Retrieves an element with a certain name from the registry.
int	getElementCount() Returns the number of elements managed by the registry.
protected abstract String	getElementName(ELEMENT element)
Set<String>	getElementNames() Returns the names of the elements managed by the registry.
Collection<ELEMENT>	getElements() Returns the list of elements managed by the registry.
boolean	hasElement(String name) Checks if an element with a certain name is managed by the registry.
boolean	hasElements() Returns if the registry has elements.
protected static boolean	isDisposingElement()
protected boolean	isRemoveDisposedElements()
protected abstract void	notifyObservers(Collection<ELEMENT> oldArray, Collection<ELEMENT> newArray) Notifies observers that the elements in the registry have changed.
void	removeObserver(OBSERVER observer) Removes an ECPObserver to the ECPObserverBus.

Methods inherited from class org.eclipse.net4j.util.lifecycle.Lifecycle

activate, checkActive, checkArg, checkArg, checkInactive, checkNull, checkState, checkState, deactivate, deferredActivate, doActivate, doAfterActivate, doBeforeActivate, doBeforeDeactivate, doDeactivate, dump, getLifecycleState, isActive, isDeferredActivation, toString

Methods inherited from class org.eclipse.net4j.util.event.Notifier

addListener, fireEvent, fireEvent, fireEvent, fireThrowable, firstListenerAdded, getListeners, getNotificationService, hasListeners, lastListenerRemoved, removeListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.net4j.util.event.INotifier

addListener, getListeners, hasListeners, removeListener

Constructor Detail

Registry

public Registry()

Default constructor.

Method Detail

getElement

public final ELEMENT getElement(String key)

Retrieves an element with a certain name from the registry.

Parameters:

key - the name of the element to retrieve

Returns:

the element or null if not contained in the registry

getElementNames

public final Set<String> getElementNames()

Returns the names of the elements managed by the registry.

Returns:

a set of strings representing the names of elements

getElementCount

public final int getElementCount()

Returns the number of elements managed by the registry.

Returns:

an integer

getElements

public final Collection<ELEMENT> getElements()

Returns the list of elements managed by the registry.

Returns:

a collection of elements

hasElements

public final boolean hasElements()

Returns if the registry has elements.

Returns:

true if the registry has elements

hasElement

public final boolean hasElement(String name)

Checks if an element with a certain name is managed by the registry.

Parameters:

name - the name of the element to check

Returns:

true if the element is managed by the registry

changeElements

public final void changeElements(Set<String> remove,
                                 Set<ELEMENT> add)

Adds or remove elements contained in the registry.

Parameters:

remove - a set of elements to be removed

add - a set of elements to be added

disposed

public final void disposed(ECPDisposable disposable)

Callback method being used to notify listeners about a dispose.

Specified by:

disposed in interface ECPDisposable.DisposeListener

Parameters:

disposable - the object being disposed

isRemoveDisposedElements

protected boolean isRemoveDisposedElements()

Returns:

Whether elements should be removed from the registry if they are disposed.

doChangeElements

protected final Set<ELEMENT> doChangeElements(Set<String> remove,
                                              Set<ELEMENT> add)

Executes adding or removing elements contained in the registry. As a caller, use changeElements().

Parameters:

remove - a set of elements to be removed

add - a set of elements to be added

Returns:

a set of elements, which have been removed

addObserver

public void addObserver(OBSERVER observer)

Adds an ECPObserver to the ECPObserverBus.

Parameters:

observer - the observer to be added

removeObserver

public void removeObserver(OBSERVER observer)

Removes an ECPObserver to the ECPObserverBus.

Parameters:

observer - the observer to be removed

notifyObservers

protected abstract void notifyObservers(Collection<ELEMENT> oldArray,
                                        Collection<ELEMENT> newArray)
                                 throws Exception

Notifies observers that the elements in the registry have changed.

Parameters:

oldArray - The old collection of elements

newArray - The new collection of elements

Throws:

Exception

elementsChanged

protected void elementsChanged(Collection<ELEMENT> oldElements,
                               Collection<ELEMENT> newElements)

getElementName

protected abstract String getElementName(ELEMENT element)

Parameters:

element - the element to retrieve a name for.

Returns:

the name of an element

isDisposingElement

protected static boolean isDisposingElement()