io.jbotsim.core

Class Properties

java.lang.Object

io.jbotsim.core.Properties

Direct Known Subclasses:

Link, Message, Node, Topology

public abstract class Properties
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.HashMap<java.lang.String,java.lang.Object>	properties

Constructor Summary

Constructors

Constructor and Description
Properties()

Method Summary

Modifier and Type	Method and Description
void	addPropertyListener(PropertyListener listener) Registers the specified property listener to this node.
java.lang.Object	getProperty(java.lang.String key) Returns the property stored under the specified key.
boolean	hasProperty(java.lang.String key) Returns the property stored under the specified key.
void	removeProperty(java.lang.String key) Removes the specified property.
void	removePropertyListener(PropertyListener listener) Unregisters the specified property listener for this node.
void	setProperty(java.lang.String key, java.lang.Object value) Stores the specified property (value) under the specified name (key).

Methods inherited from class java.lang.Object

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

Field Detail

properties

protected java.util.HashMap<java.lang.String,java.lang.Object> properties

Constructor Detail

Properties

public Properties()

Method Detail

addPropertyListener

public void addPropertyListener(PropertyListener listener)

Registers the specified property listener to this node. The listener will be notified every time a property of this node changes.

Parameters:

listener - The movement listener.

removePropertyListener

public void removePropertyListener(PropertyListener listener)

Unregisters the specified property listener for this node.

Parameters:

listener - The property listener.

getProperty

public java.lang.Object getProperty(java.lang.String key)

Returns the property stored under the specified key.

Parameters:

key - The property key.

Returns:

the Object corresponding to the provided key

setProperty

public void setProperty(java.lang.String key,
                        java.lang.Object value)

Stores the specified property (value) under the specified name (key).

Parameters:

key - The property name.

value - The property value.

removeProperty

public void removeProperty(java.lang.String key)

Removes the specified property.

Parameters:

key - The property key.

hasProperty

public boolean hasProperty(java.lang.String key)

Returns the property stored under the specified key.

Parameters:

key - The property key.

Returns:

true is the provided key corresponds to a known propery, false otherwise.