com.force.i18n

Interface LabelSet

All Superinterfaces:

BaseNonConfigIniFile, NonConfigIniFile, Serializable, SharedLabelSet

All Known Subinterfaces:

GrammaticalLabelSet, GrammaticalLabelSet.GrammaticalLabelSetComposite

All Known Implementing Classes:

GrammaticalLabelSetFallbackImpl, GrammaticalLabelSetImpl, LabelSetImpl

public interface LabelSet
extends SharedLabelSet, Serializable

An interface to a label set. Provides some helper methods to provide debugging access to the original parsed files, such as getLastModified() and getLabelSectionToFilename()

Author:

stamm

Method Summary

Modifier and Type	Method and Description
boolean	containsParam(String sectionName, String paramName)
boolean	containsSection(String sectionName)
Map<String,String>	getLabelSectionToFilename()
long	getLastModified()
Set<String>	getParams(String sectionName)
Set<String>	getParams(String sectionName, Set<String> ifNull)
Set<String>	sectionNames()

Methods inherited from interface com.force.i18n.SharedLabelSet

labelExists

Methods inherited from interface com.force.i18n.commons.util.settings.NonConfigIniFile

get, getBoolean, getFloat, getInt, getList, getSection, getString, getStringThrow

Methods inherited from interface com.force.i18n.commons.util.settings.BaseNonConfigIniFile

entrySet, get, getBoolean, getCensoredString, getFloat, getInt, getList, getString

Method Detail

getLabelSectionToFilename

Map<String,String> getLabelSectionToFilename()

Returns:

the mapping from label section to file name, if it exists, otherwise null

sectionNames

Set<String> sectionNames()

Returns:

the set of all section names available in this label set

getParams

Set<String> getParams(String sectionName)

Parameters:

sectionName - name of the section

Returns:

the values inside the section setified.

Throws:

SettingsSectionNotFoundException - if the section does not exist.

getParams

Set<String> getParams(String sectionName,
                      Set<String> ifNull)

Parameters:

sectionName - the name of the section

ifNull - the value to return for the parameters if there is no section with that name

Returns:

the values inside the section setified.

containsParam

boolean containsParam(String sectionName,
                      String paramName)

Parameters:

sectionName - name of the section

paramName - key for the parameter

Returns:

true if the label set contains the given parameter

containsSection

boolean containsSection(String sectionName)

Parameters:

sectionName - the key of the section

Returns:

true if the label set contains a label with the given sectionName. This should return in quickly in O(1), unlike sectionNames()

getLastModified

long getLastModified()

Returns:

the timestamp of the last modified label file