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

Class SimpleDiscreteKeyManager

java.lang.Object

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

All Implemented Interfaces:

IKeyManager

public class SimpleDiscreteKeyManager
extends java.lang.Object
implements IKeyManager

This class provides a simple IKeyManager based on a defined list of keys specified in the constructor. Keys can be taken and released using the methods in this class.

Author:

Jordan Deyton

Constructor Summary

Constructors

Constructor and Description
SimpleDiscreteKeyManager(java.lang.String... keys) Creates a simple key manager with a pre-defined list of allowed keys.

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	releaseKeys(java.lang.String... keys) Releases all specified keys, making them available if they are valid.
void	removeKeyChangeListener(IKeyChangeListener listener) Removes an existing IKeyChangeListener from the key manager.
void	takeKeys(java.lang.String... keys) Takes all specified keys if they are available and valid.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleDiscreteKeyManager

public SimpleDiscreteKeyManager(java.lang.String... keys)

Creates a simple key manager with a pre-defined list of allowed keys. All specified keys are available by default.

Parameters:

keys - The list of allowed keys. Null is allowed, but duplicate values will be ignored.

Method Detail

takeKeys

public void takeKeys(java.lang.String... keys)

Takes all specified keys if they are available and valid. Invalid keys are ignored. Taken keys will not be listed as available after this method completes.

Parameters:

keys - The list of keys to take.

releaseKeys

public void releaseKeys(java.lang.String... keys)

Releases all specified keys, making them available if they are valid. Invalid keys are ignored.

Parameters:

keys - The list of keys 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.