Interface PropertyExporter

All Superinterfaces:

Auditable, PropertyNameSource, PropertySource

All Known Implementing Classes:

ActionButton, AreaOfEffect, Attachment, BasicName, BasicPiece, BorderOutline, CalculatedProperty, Clone, Comment, CounterGlobalKeyCommand, Decorator, Delete, Deselect, DynamicProperty, Embellishment, Embellishment0, Footprint, FreeRotator, GlobalHotKey, Hideable, Immobilized, Labeler, Marker, Mat, MatCargo, MenuSeparator, MovementMarkable, MultiLocationCommand, NonRectangular, Obscurable, Pivot, PlaceMarker, PlaySound, PropertySheet, Replace, ReportState, RestrictCommands, Restricted, ReturnToDeck, SendToLocation, SetGlobalProperty, SetPieceProperty, SubMenu, TableInfo, TranslatableMessage, Translate, TriggerAction, UsePrototype

public interface PropertyExporter
extends PropertyNameSource, PropertySource

Interface for classes that can export the names and values of the properties they maintain

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LOCALIZED_NAME

Method Summary

Modifier and Type	Method	Description
default Map<String,Object>	getProperties()	Return a Map of properties
default Map<String,Object>	getProperties(Map<String,Object> result)	Update an existing Map of Properties and return the Map.

Methods inherited from interface Auditable

getComponentName, getComponentTypeName

Modifier and Type	Method	Description
default String	getComponentName()	Return the name of the trait or Component an Auditable is
default String	getComponentTypeName()	Return a description of the Type of trait or Component an Auditable is

Methods inherited from interface PropertyNameSource

getPropertyNames

Modifier and Type	Method	Description
List<String>	getPropertyNames()

Methods inherited from interface PropertySource

getLocalizedProperty, getProperty

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.

Field Details

LOCALIZED_NAME

static final String LOCALIZED_NAME

See Also:

• Constant Field Values

Method Details

getProperties

default Map<String,Object> getProperties()

Return a Map of properties

Returns:

Property Map

getProperties

default Map<String,Object> getProperties(Map<String,Object> result)

Update an existing Map of Properties and return the Map. Do not overwrite the value if a property with the same name already exists.

Parameters:

result - Map of properties

Returns:

Update property Map