com.force.i18n.settings

Class SharedKeyMapPropertyFileData

java.lang.Object

com.force.i18n.settings.SharedKeyMapPropertyFileData

All Implemented Interfaces:

PropertyFileData, Serializable

public class SharedKeyMapPropertyFileData
extends Object
implements PropertyFileData, Serializable

An implementation of property file data (e.g. label data) that shares the section name keys and parameter name keys across various languages.

Some care needs to be taken with the thread safetyness of this class, as the internal SharedKeyMap can be mutated by multiple threads.

Author:

koliver

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SharedKeyMapPropertyFileData(Locale locale, boolean isPrimary, SharedKeyMap<String,SharedKeyMap<String,Object>> seed, Set<String> publicSections)

Method Summary

Modifier and Type	Method and Description
void	compact()
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) If this implementation supports sharing of section and parameter names, then this should allow a non-shared representation to "hop" onto the sharing bandwagon.

Methods inherited from class java.lang.Object

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

Constructor Detail

SharedKeyMapPropertyFileData

public SharedKeyMapPropertyFileData(Locale locale,
                                    boolean isPrimary,
                                    SharedKeyMap<String,SharedKeyMap<String,Object>> seed,
                                    Set<String> publicSections)

Parameters:

locale - The locale id should correspond to a value that came from the g11n.xml file

isPrimary - this is the only label set that can define new sections.

seed - this is the shared key map that is shared across multiple locale's versions of the data.

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.

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

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)

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

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"

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.

compact

public void compact()

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.

shareKeys

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

Description copied from interface: PropertyFileData

If this implementation supports sharing of section and parameter names, then this should allow a non-shared representation to "hop" onto the sharing bandwagon.

This is not always supported by implementations. If the implementation doesn't support it, it should be considered a no-op.

Specified by:

shareKeys in interface PropertyFileData

See Also:

SharedKeyMapPropertyFileData