org.eclipse.eavp.viz.service.connections.preferences.test

Class SimpleCountKeyManager

java.lang.Object

org.eclipse.eavp.viz.service.connections.preferences.test.SimpleCountKeyManager

All Implemented Interfaces:

IKeyManager

public class SimpleCountKeyManager
extends java.lang.Object
implements IKeyManager

This class provides a very simple unrestricted or "undefined" key manager that generates keys based on an integer counter. When the next key is taken, the counter is incremented and the next available key is updated.

Author:

Jordan Deyton

Constructor Summary

Constructors

Constructor and Description
SimpleCountKeyManager()

Method Summary

Modifier and Type	Method and Description
void	addKeyChangeListener(IKeyChangeListener listener) Adds a new IKeyChangeListener to listen for key change events in the manager.
java.util.List<java.lang.String>	getAvailableKeys() Gets the list of available keys.
java.lang.String	getNextKey() Returns the next available key, usually based on some default prefix, e.g., "key1", "key2".
boolean	keyAvailable(java.lang.String key) Determines whether the specified key is available.
void	releaseKey(java.lang.String key) Releases the specified key if it is valid.
void	removeKeyChangeListener(IKeyChangeListener listener) Removes an existing IKeyChangeListener from the key manager.
java.lang.String	takeKey() Takes the next available key if it is available.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleCountKeyManager

public SimpleCountKeyManager()

Method Detail

takeKey

public java.lang.String takeKey()

Takes the next available key if it is available.

Listeners are notified that the key has been taken.

Returns:

The next available key, count, as a string.

releaseKey

public void releaseKey(java.lang.String key)

Releases the specified key if it is valid.

Listeners are notified that the key has been released.

Parameters:

key - The key to release.

keyAvailable

public boolean keyAvailable(java.lang.String key)

Description copied from interface: IKeyManager

Determines whether the specified key is available.

Specified by:

keyAvailable in interface IKeyManager

Parameters:

key - The key to test.

Returns:

True if the key is available, false otherwise.

getAvailableKeys

public java.util.List<java.lang.String> getAvailableKeys()

Description copied from interface: IKeyManager

Gets the list of available keys.

Specified by:

getAvailableKeys in interface IKeyManager

Returns:

A list containing the available keys. If there are none left or there is no limited set of keys, this list will be empty.

getNextKey

public java.lang.String getNextKey()
                            throws java.lang.IllegalStateException

Description copied from interface: IKeyManager

Returns the next available key, usually based on some default prefix, e.g., "key1", "key2".

Specified by:

getNextKey in interface IKeyManager

Returns:

The next available key.

Throws:

java.lang.IllegalStateException - An exception is thrown if there is a pre-defined list of keys and there are no more keys available.

addKeyChangeListener

public void addKeyChangeListener(IKeyChangeListener listener)

Description copied from interface: IKeyManager

Adds a new IKeyChangeListener to listen for key change events in the manager.

Specified by:

addKeyChangeListener in interface IKeyManager

Parameters:

listener - The new listener. The same listener should not be added twice.

removeKeyChangeListener

public void removeKeyChangeListener(IKeyChangeListener listener)

Description copied from interface: IKeyManager

Removes an existing IKeyChangeListener from the key manager.

Specified by:

removeKeyChangeListener in interface IKeyManager

Parameters:

listener - The old listener. This removes the first matching occurrence of the listener from the manager.