Package VASSAL.build.module.properties

Interface MutablePropertiesContainer

All Known Implementing Classes:

BasicModule, GameModule, GlobalProperties, Map, MutablePropertiesContainer.Impl, PlayerHand, PrivateMap, ScenarioPropertiesOptionTab, WidgetMap, Zone

public interface MutablePropertiesContainer

A component that can contain mutable (updatable) properties

Author:

rkinney

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	MutablePropertiesContainer.Impl	Simple implementation of MutablePropertiesContainer

Method Summary

Modifier and Type	Method	Description
void	addMutableProperty(String key, MutableProperty p)	Add a property under the given key
String	getMutablePropertiesContainerId()	Return a unique Id for the container
MutableProperty	getMutableProperty(String propertyName)	Find a GlobalProperty object with the given name
MutableProperty	removeMutableProperty(String key)	Remove the property with the given key

Method Details

addMutableProperty

void addMutableProperty(String key,
 MutableProperty p)

Add a property under the given key

Parameters:

key - key

p - property

removeMutableProperty

MutableProperty removeMutableProperty(String key)

Remove the property with the given key

Parameters:

key - key

getMutableProperty

MutableProperty getMutableProperty(String propertyName)

Find a GlobalProperty object with the given name

getMutablePropertiesContainerId

String getMutablePropertiesContainerId()

Return a unique Id for the container