com.force.i18n.settings

Interface PropertyFileData

All Superinterfaces:

Serializable

All Known Implementing Classes:

MapPropertyFileData, SharedKeyMapPropertyFileData, SkinnyMapPropertyFileData

public interface PropertyFileData
extends Serializable

Stores our configuration (and label) data. Data is referenced by 2-level keys: section name and then parameter name within that section.

Author:

koliver

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

Method Detail

getSection

Map<String,Object> getSection(String sectionName)

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

entrySet

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

Returns:

an unmodifiable view of the data.

put

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

Adds a value to the data.

Returns:

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

remove

Object remove(String sectionName,
              String paramName)

Removes the value for a section/parameter key,

Returns:

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

removeSection

void removeSection(String sectionName)

Removes all properties for the given section name.

getSectionNames

Set<String> getSectionNames()

Returns an unmodifiable set of section names in the data.

getPublicSectionNames

Set<String> getPublicSectionNames()

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

setSectionAsPublic

void setSectionAsPublic(String section)

The set of "public" sections.

Parameters:

section - the section to mark as "public"

containsSection

boolean containsSection(String sectionName)

Returns:

whether or not the section exists.

See Also:

contains(String, String)

contains

boolean contains(String sectionName,
                 String paramName)

Returns:

whether or not the property exists.

See Also:

containsSection(String)

getLocale

Locale getLocale()

Gets the locale associated with this data if any

Returns:

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

shareKeys

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.

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

See Also:

SharedKeyMapPropertyFileData