| net.refractions.udig.project.IBlackboard
All known Subclasses: net.refractions.udig.project.internal.SimpleBlackboard,
| IBlackboard | | public interface IBlackboard (Code) | | Provide Temporary for shared collaboration between renderers and the user.
To emphais the tempoary nature we are not storing objects at this time, please see
StyleBlackboard for the direction we wish to take this class. API should this interface be
included?
Q: Should this class be cloneable? API explain the use of 'keys' and any uniqueness constraints
(Set or List?) API X getX(key) ... should this be X get(key) and let the compiler firgure out
which one to call based on the signature? API moreover, you might want to consider on 'Objects'
and the use of in the API, using generics to avoid multiple get and put methods. API looks
alot like a Map ... either document a comparison or add an extends clause?
author:
Jody Garnett
since:
0.7.0 |
| Method Summary | |
| boolean | addListener(IBlackboardListener listener)
Adds a listener to the blackboard. | | public void | clear()
Clear the contents of this blackboard.
This is a clear() method, not a dispose(), resource handling is not provided.
It is not recommend that client code store *real* (such as Images) resources on the
blackboard. | | boolean | contains(String key)
Check if blackboard has an entry for key. | | public void | flush()
Flush the contents of this blackboard. | | public Object | get(String key)
Returns the object value of the given key. | | public Float | getFloat(String key)
Returns the floating point value of the given key. | | public Integer | getInteger(String key)
Returns the integer value of the given key. | | public String | getString(String key)
Returns the string value of the given key. | | public void | put(String key, Object value)
Sets the value of the given key. | | public void | putFloat(String key, float value)
Sets the value of the given key to the given floating point number. | | public void | putInteger(String key, int value)
Sets the value of the given key to the given integer. | | public void | putString(String key, String value)
Sets the value of the given key to the given string. | | boolean | removeListener(IBlackboardListener listener)
Removes a listener
Parameters:
listener - the listener to be removed. |
| addListener | | boolean addListener(IBlackboardListener listener)(Code) | | Adds a listener to the blackboard. Duplicates are not permitted.
Parameters:
listener - a listener that will be notified when the blackboard changes true if the collection changed as a result of the call. |
| clear | | public void clear()(Code) | | Clear the contents of this blackboard.
This is a clear() method, not a dispose(), resource handling is not provided.
It is not recommend that client code store *real* (such as Images) resources on the
blackboard. This is not a ImageCache that will magically handle resource management for you.
|
| contains | | boolean contains(String key)(Code) | | Check if blackboard has an entry for key.
true if a value is known for key |
| flush | | public void flush()(Code) | | Flush the contents of this blackboard.
This signals the blackboard to save any contents, and clear any cached object references.
|
| get | | public Object get(String key)(Code) | | Returns the object value of the given key.
Parameters:
key - the key the value, or null if the key was not found |
| getFloat | | public Float getFloat(String key)(Code) | | Returns the floating point value of the given key.
Parameters:
key - the key the value, or null if the key was not found or was found but was not afloating point number |
| getInteger | | public Integer getInteger(String key)(Code) | | Returns the integer value of the given key.
Parameters:
key - the key the value, or null if the key was not found or was found but was notan integer |
| getString | | public String getString(String key)(Code) | | Returns the string value of the given key.
Parameters:
key - the key the value, or null if the key was not found |
| put | | public void put(String key, Object value)(Code) | | Sets the value of the given key.
Parameters:
key - the key
Parameters:
value - the value |
| putFloat | | public void putFloat(String key, float value)(Code) | | Sets the value of the given key to the given floating point number.
Parameters:
key - the key
Parameters:
value - the value |
| putInteger | | public void putInteger(String key, int value)(Code) | | Sets the value of the given key to the given integer.
Parameters:
key - the key
Parameters:
value - the value |
| putString | | public void putString(String key, String value)(Code) | | Sets the value of the given key to the given string.
Parameters:
key - the key
Parameters:
value - the value |
| removeListener | | boolean removeListener(IBlackboardListener listener)(Code) | | Removes a listener
Parameters:
listener - the listener to be removed. true if the collection contained the specifiedelement. |
|
|