com.tensegrity.composite
Class HighlightRegistry

java.lang.Object
  com.tensegrity.composite.HighlightRegistry

public class HighlightRegistry

extends java.lang.Object

TODO: comment

Version:

$Id: HighlightRegistry.java,v 1.2 2004/12/22 16:45:01 BurkhardWick Exp $

Author:

MKegel

Constructor Summary

HighlightRegistry()
Constructor for HighlightRegistry.

HighlightRegistry(HighlightRegistry registry)
Copy contructor for HighlightRegistry.

Method Summary

void	clear() Unregisters all registered highlight composites from the registry such that it is empty afterwards.
boolean	containsCursor(java.lang.Object cursor) Returns a boolean that indicates whether the given cursor (repectively cursor identifier) is registered at the registry or not.
boolean	containsKey(java.lang.Object key) Returns a boolean that indicates whether a cursor with the given key is registered at the registry or not.
java.util.Iterator	cursorIterator() Returns an Iterator that can be use to iteratr over the currently registered highlight composites (or cursor identifier).
HighlightRegistry	deepCopy()
Composite	get(java.lang.Object key) Returns the highlight composite that for the given key.
boolean	isEmpty() Returns a boolean that indicates whether the registry is emty or not.
java.util.Iterator	keyIterator() Returns an Iterator that can be used to iterate over the keys of the currently registered highlight composites (or cursor identifier).
void	register(java.lang.Object key, Composite highlight) Registers the given highlight with the given key at the registry.
int	size() Returns the current amoung of registered highlight composites.
void	unregister(java.lang.Object key) Unregisters (repectively removes) the highlight composite that is registered with the given key from the registry.

Methods inherited from class java.lang.Object

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

Constructor Detail

HighlightRegistry

public HighlightRegistry()

Constructor for HighlightRegistry.

HighlightRegistry

public HighlightRegistry(HighlightRegistry registry)

Copy contructor for HighlightRegistry.

Parameters:

registry - the HighlightRegistry to copy

Method Detail

isEmpty

public boolean isEmpty()

Returns a boolean that indicates whether the registry is emty or not.

Returns:

boolean flag that indicates whether the registry is empty or not

containsKey

public boolean containsKey(java.lang.Object key)

Returns a boolean that indicates whether a cursor with the given key is registered at the registry or not.

Parameters:

key - to check for

Returns:

boolean flag that indicates whether a cursor for the key is registered or not

containsCursor

public boolean containsCursor(java.lang.Object cursor)

Returns a boolean that indicates whether the given cursor (repectively cursor identifier) is registered at the registry or not.

Parameters:

cursor - the cursor (or cursor identifier) to check for

Returns:

boolean a flag that indicates whether the given cursor (or cursor identifier) is registered or not

size

public int size()

Returns the current amoung of registered highlight composites.

Returns:

int the current count of highlight composites

register

public void register(java.lang.Object key,
                     Composite highlight)

Registers the given highlight with the given key at the registry. This registered highlight can be accessed later on by the given key.

If there is already a highlight registered for the given key it will be replaced by a call to this method.

Parameters:

key - for the given highlight

highlight - the highlight composite to register

unregister

public void unregister(java.lang.Object key)

Unregisters (repectively removes) the highlight composite that is registered with the given key from the registry.

If there is no highlight composite with the given key registered at the registry the method does nothing.

Parameters:

key - the key of the highlight composite to unregister from the registry

get

public Composite get(java.lang.Object key)

Returns the highlight composite that for the given key.

If no highlight composite is registered for the given key this method returns null.

Parameters:

key - the key of the highlight composite to unregister from the registry

Returns:

the highlight composite instance

clear

public void clear()

Unregisters all registered highlight composites from the registry such that it is empty afterwards.

keyIterator

public java.util.Iterator keyIterator()

Returns an Iterator that can be used to iterate over the keys of the currently registered highlight composites (or cursor identifier).

The returned iterator does not allow to remove a cursor from the registry.

Returns:

iterator to iterate over the keys of the registered highlight composites

cursorIterator

public java.util.Iterator cursorIterator()

Returns an Iterator that can be use to iteratr over the currently registered highlight composites (or cursor identifier).

The returned iterator does not allow to remove a cursor from the registry.

Returns:

iterator to iterate over the the registered highlight composites

deepCopy

public HighlightRegistry deepCopy()