com.force.i18n.settings

Class SkinnyMapPropertyFileData

java.lang.Object

com.force.i18n.settings.SkinnyMapPropertyFileData

All Implemented Interfaces:

PropertyFileData, Serializable

public final class SkinnyMapPropertyFileData
extends Object
implements PropertyFileData

Responsible for providing property file data in a space efficient way. By using SkinnyMapPropertyFileData's the overhead per map element stored at both levels is reduced to 8 bytes per entry. Most other Map implementation have higher per entry overheads. The trade of is the cost of get's will go from O(1) to O(logN). So clients that can afford slower gets, and have memory conscious requirements, should consider using this over other PropertyFileData implementations. Also, instances of SkinnyMapPropertyFileData will only be truly immutable if the concrete Object in 'data' is immutable (i.e. String).

Author:

btoal

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SkinnyMapPropertyFileData(MapPropertyFileData m) Creates a new SkinnyMapPropertyFileData from existing MapPropertyFileData

Method Summary

Modifier and Type	Method and Description
boolean	contains(String sectionName, String paramName) returns if a parameter exists (true) or not (false) for the specified section.
boolean	containsSection(String sectionName) returns if a section exists (true) or not (false) in this property data.
Set<Map.Entry<String,Map<String,Object>>>	entrySet() Returns the set sections and corresponding parameters/values.
Locale	getLocale() Get's copy of locale.
Set<String>	getPublicSectionNames() Returns set of public sections.
Map<String,Object>	getSection(String sectionName) Returns section, if exists from property file metadata.
Set<String>	getSectionNames() Returns set of section names.
Object	put(String sectionName, String paramName, Object value) Use of method will always result in IllegalStateException.
Object	remove(String sectionName, String paramName) Use of method will always result in IllegalStateException.
void	removeSection(String sectionName) Use of method will always result in IllegalStateException.
void	setSectionAsPublic(String section) Use of method will always result in IllegalStateException.
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

SkinnyMapPropertyFileData

public SkinnyMapPropertyFileData(MapPropertyFileData m)

Creates a new SkinnyMapPropertyFileData from existing MapPropertyFileData

Parameters:

m - MapPropertyFileData that will be copied into a ImmutableSortedMap.

Method Detail

getSection

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

Returns section, if exists from property file metadata.

Specified by:

getSection in interface PropertyFileData

entrySet

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

Returns the set sections and corresponding parameters/values.

Specified by:

entrySet in interface PropertyFileData

Returns:

an unmodifiable view of the data.

containsSection

public boolean containsSection(String sectionName)

returns if a section exists (true) or not (false) in this property data.

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)

returns if a parameter exists (true) or not (false) for the specified section.

Specified by:

contains in interface PropertyFileData

Returns:

whether or not the property exists.

See Also:

PropertyFileData.containsSection(String)

getLocale

public Locale getLocale()

Get's copy of locale.

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.

getSectionNames

public Set<String> getSectionNames()

Returns set of section names.

Specified by:

getSectionNames in interface PropertyFileData

getPublicSectionNames

public Set<String> getPublicSectionNames()

Returns set of public sections.

Specified by:

getPublicSectionNames in interface PropertyFileData

put

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

Use of method will always result in IllegalStateException. This is because the data within SkinnyMapPropertyFileData should not be modified.

Specified by:

put in interface PropertyFileData

Returns:

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

remove

public Object remove(String sectionName,
                     String paramName)

Use of method will always result in IllegalStateException. This is because the data within SkinnyMapPropertyFileData should not be modified.

Specified by:

remove in interface PropertyFileData

Returns:

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

removeSection

public void removeSection(String sectionName)

Use of method will always result in IllegalStateException. This is because the data within SkinnyMapPropertyFileData should not be modified.

Specified by:

removeSection in interface PropertyFileData

setSectionAsPublic

public void setSectionAsPublic(String section)

Use of method will always result in IllegalStateException. This is because the data within SkinnyMapPropertyFileData should not be modified.

Specified by:

setSectionAsPublic in interface PropertyFileData

Parameters:

section - the section to mark as "public"

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