Package VASSAL.build.module.properties

Class SumProperties

java.lang.Object

VASSAL.build.module.properties.SumProperties

All Implemented Interfaces:

PropertySource

public class SumProperties
extends Object
implements PropertySource

For property names of the form sum(name), returns the value of the named property summed over a list of pieces.

Author:

rkinney

Field Summary

Fields

Modifier and Type	Field	Description
protected Collection<GamePiece>	pieces

Constructor Summary

Constructors

Constructor	Description
SumProperties(Collection<GamePiece> pieces)

Method Summary

Modifier and Type	Method	Description
Object	getLocalizedProperty(Object key)	Returns a localized translation of the specified property value, if available.
Object	getProperty(Object key)	When using this interface a piece's own properties are preferred to those of "Global Properties", and those in turn are searched Zone-first then Map, then Module.

Methods inherited from class java.lang.Object

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

Field Details

pieces

protected Collection<GamePiece> pieces

Constructor Details

SumProperties

public SumProperties(Collection<GamePiece> pieces)

Method Details

getProperty

public Object getProperty(Object key)

Description copied from interface: PropertySource

When using this interface a piece's own properties are preferred to those of "Global Properties", and those in turn are searched Zone-first then Map, then Module.

Specified by:

getProperty in interface PropertySource

Parameters:

key - String key of property to be returned

Returns:

Object containing value of the specified property

getLocalizedProperty

public Object getLocalizedProperty(Object key)

Description copied from interface: PropertySource

Returns a localized translation of the specified property value, if available. Otherwise returns the non-localized version.

Specified by:

getLocalizedProperty in interface PropertySource

Parameters:

key - String key of property to be returned

Returns:

Object containing localized text of the specified property, if available, otherwise non-localized value