com.force.i18n.settings

Class MapPropertyFileData

java.lang.Object

com.force.i18n.settings.MapPropertyFileData

All Implemented Interfaces:

PropertyFileData, Serializable

public class MapPropertyFileData
extends Object
implements PropertyFileData, Serializable

A standard implementation of PropertyFileData that is a HashMap of section name to HashMaps of parameter name to values.

If there is overlap between the section or parameter keys with, say another language's version, you should consider using the SharedKeyMapPropertyFileData implementation.

Since:

146

Author:

koliver

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Map<String,Object>>	data
protected Locale	locale
protected Set<String>	publicSections

Constructor Summary

Constructors

Constructor and Description
MapPropertyFileData() Use this constructor if you are uninterested in locale specific data.
MapPropertyFileData(Locale locale)

Method Summary

Modifier and Type	Method and Description
boolean	contains(String sectionName, String paramName)
boolean	containsSection(String sectionName)
Set<Map.Entry<String,Map<String,Object>>>	entrySet()
Locale	getLocale() Gets the locale associated with this data if any
Set<String>	getPublicSectionNames() Returns an unmodifiable map of section names that are "namespaced" in that they are publicly accessible and versioned.
Map<String,Object>	getSection(String sectionName) Returns an unmodifiable map of all the values for a particular sectionName.
Set<String>	getSectionNames() Returns an unmodifiable set of section names in the data.
Object	put(String sectionName, String paramName, Object value) Adds a value to the data.
Object	remove(String sectionName, String paramName) Removes the value for a section/parameter key,
void	removeSection(String sectionName) Removes all properties for the given section name.
void	setSectionAsPublic(String section) The set of "public" sections.
void	shareKeys(SharedKeyMap<String,SharedKeyMap<String,Object>> seedKeyMap) No-op.

Methods inherited from class java.lang.Object

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

Field Detail

locale

protected final Locale locale

data

protected final Map<String,Map<String,Object>> data

publicSections

protected final Set<String> publicSections

Constructor Detail

MapPropertyFileData

public MapPropertyFileData()

Use this constructor if you are uninterested in locale specific data. Means that getLocale() will throw an exception if called.

MapPropertyFileData

public MapPropertyFileData(Locale locale)

Parameters:

locale - the locale of this property file data Only use this constructor if you are dealing with data that is specific to a locale. The locale id should correspond to a value that came from the global.locale table.

Method Detail

getLocale

public Locale getLocale()

Description copied from interface: PropertyFileData

Gets the locale associated with this data if any

Specified by:

getLocale in interface PropertyFileData

Returns:

the locale associated with this property data. Some implementations may not require specifying this, and thus may throw an exception if called.

Throws:

IllegalStateException - if this is called when constructed without a localeId specified.

getSection

public Map<String,Object> getSection(String sectionName)

Description copied from interface: PropertyFileData

Returns an unmodifiable map of all the values for a particular sectionName. If, that section does not exist, will return null.

Specified by:

getSection in interface PropertyFileData

entrySet

public Set<Map.Entry<String,Map<String,Object>>> entrySet()

Specified by:

entrySet in interface PropertyFileData

Returns:

an unmodifiable view of the data.

getSectionNames

public Set<String> getSectionNames()

Description copied from interface: PropertyFileData

Returns an unmodifiable set of section names in the data.

Specified by:

getSectionNames in interface PropertyFileData

getPublicSectionNames

public Set<String> getPublicSectionNames()

Description copied from interface: PropertyFileData

Returns an unmodifiable map of section names that are "namespaced" in that they are publicly accessible and versioned. The keys of the namespaces are all "lowercase", unlike normal section names, which are the associated values

Specified by:

getPublicSectionNames in interface PropertyFileData

removeSection

public void removeSection(String sectionName)

Description copied from interface: PropertyFileData

Removes all properties for the given section name.

Specified by:

removeSection in interface PropertyFileData

remove

public Object remove(String sectionName,
                     String paramName)

Description copied from interface: PropertyFileData

Removes the value for a section/parameter key,

Specified by:

remove in interface PropertyFileData

Returns:

the old value for this section/parameter key, or null if no value existed.

containsSection

public boolean containsSection(String sectionName)

Specified by:

containsSection in interface PropertyFileData

Returns:

whether or not the section exists.

See Also:

PropertyFileData.contains(String, String)

contains

public boolean contains(String sectionName,
                        String paramName)

Specified by:

contains in interface PropertyFileData

Returns:

whether or not the property exists.

See Also:

PropertyFileData.containsSection(String)

put

public Object put(String sectionName,
                  String paramName,
                  Object value)

Description copied from interface: PropertyFileData

Adds a value to the data.

Specified by:

put in interface PropertyFileData

Returns:

the old value for this section/parameter key, or null if no value existed.

setSectionAsPublic

public void setSectionAsPublic(String section)

Description copied from interface: PropertyFileData

The set of "public" sections.

Specified by:

setSectionAsPublic in interface PropertyFileData

Parameters:

section - the section to mark as "public"

shareKeys

public void shareKeys(SharedKeyMap<String,SharedKeyMap<String,Object>> seedKeyMap)

No-op.

Specified by:

shareKeys in interface PropertyFileData

See Also:

SharedKeyMapPropertyFileData